openapi: 3.1.1
info:
  title: Credit Transfer Initiation API
  version: v1.0
  summary: >-
    Fast Payment is a near real time feature that lets you send money to most
    Australian financial institutions through the New Payments Platform (NPP).
  description: >-
    Fast Payment via API is the digital way to send payments using the NPP-fast,
    flexible and embedded in your system. It is the ideal solution for business
    making high volumes, time-sensitive payments and with requirements for
    custom, embedded payment solutions.
tags:
  - name: Credit Transfer Initiations
    description: Submit real-time credit transfer payment instructions via ISO 20022.
x-kong-service: PAAS_ZONE_NAME
x-kong-plugin-rate-limiting-advanced:
  config:
    limit:
      - 1000
    window_size:
      - 1
    identifier: service
    sync_rate: 0.3
    window_type: fixed
    strategy: redis
    namespace: PAAS_TARGET_ENVIRONMENT-strategic-credit-transfer-initiations
    redis:
      ssl: true
      cluster_nodes:
        - ip: REDIS_RATELIMITING_CLUSTER_HOST
          port: REDIS_RATELIMITING_CLUSTER_PORT
      username: '{vault://env/REDIS_RL_USER_NAME}'
      password: '{vault://env/REDIS_RL_PASSWORD}'
paths:
  /core-payments/payment-initiation/v1/credit-transfer-initiations:
    post:
      operationId: post-v1-payment-initiation
      tags:
        - Credit Transfer Initiations
      summary: Payment Initiation Credit Transfer
      description: Payment Initiation Credit Transfer
      x-kong-plugin-openid-connect:
        config:
          auth_methods:
            - bearer
          scopes_required:
            - payment-initiation.core-payments.credit-transfer-initiations.write
          issuer: GROUP_IDP_URL
          issuers_allowed:
            - GROUP_IDP_URL
            - GROUP_IDP_LATEST_INTERNAL_URL
          extra_jwks_uris:
            - GROUP_IDP_URL:8443/pf/JWKS
            - GROUP_IDP_LATEST_INTERNAL_URL/tls/pf/JWKS
          introspection_endpoint: GROUP_IDP_URL/as/introspect.oauth2
          credential_claim:
            - client_id
      x-kong-plugin-rate-limiting-advanced:
        config:
          limit:
            - 1000
          window_size:
            - 1
          identifier: consumer
          sync_rate: 0.3
          window_type: fixed
          strategy: redis
          namespace: PAAS_TARGET_ENVIRONMENT-strategic-credit-transfer-initiations
          redis:
            ssl: true
            cluster_nodes:
              - ip: REDIS_RATELIMITING_CLUSTER_HOST
                port: REDIS_RATELIMITING_CLUSTER_PORT
            username: '{vault://env/REDIS_RL_USER_NAME}'
            password: '{vault://env/REDIS_RL_PASSWORD}'
      x-kong-consumer-groups:
        - name: ct-initiations-HIGH
          consumers:
            - empty.group.placeholder
          plugins:
            - name: rate-limiting-advanced
              config:
                limit:
                  - CT_INITIATIONS_HIGH_RATE_LIMIT
                window_size:
                  - 1
                identifier: consumer
                sync_rate: 0.3
                window_type: fixed
                strategy: redis
                namespace: PAAS_TARGET_ENVIRONMENT-strategic-credit-transfer-initiations
                redis:
                  ssl: true
                  cluster_nodes:
                    - ip: REDIS_RATELIMITING_CLUSTER_HOST
                      port: REDIS_RATELIMITING_CLUSTER_PORT
                  username: '{vault://env/REDIS_RL_USER_NAME}'
                  password: '{vault://env/REDIS_RL_PASSWORD}'
        - name: ct-initiations-MAX
          consumers:
            - payment-initiation.int.npd.paas
          plugins:
            - name: rate-limiting-advanced
              config:
                limit:
                  - CT_INITIATIONS_MAX_RATE_LIMIT
                window_size:
                  - 1
                identifier: consumer
                sync_rate: 0.3
                window_type: fixed
                strategy: redis
                namespace: PAAS_TARGET_ENVIRONMENT-strategic-credit-transfer-initiations
                redis:
                  ssl: true
                  cluster_nodes:
                    - ip: REDIS_RATELIMITING_CLUSTER_HOST
                      port: REDIS_RATELIMITING_CLUSTER_PORT
                  username: '{vault://env/REDIS_RL_USER_NAME}'
                  password: '{vault://env/REDIS_RL_PASSWORD}'
      parameters:
        - name: x-request-id
          in: header
          description: >-
            This header parameter identifies an API interaction. It must be
            provided in every request and is echoed in each 2xx response. It can
            also be echoed in the HTTP 4xx and 5xx responses in case of errors
            being returned by the server. The value must be a uuid.
          required: true
          schema:
            type: string
            format: uuid
            maxLength: 36
            minLength: 36
            pattern: >-
              ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
          example: 550e8400-e29b-41d4-a716-446655440000
        - name: x-idempotency-id
          in: header
          description: >-
            This header parameter represents an idempotency key for a POST API
            interaction. It must be provided in every request and have the same
            value in case of an idempotent retry.
          required: true
          schema:
            type: string
            format: uuid
            maxLength: 36
            minLength: 36
            pattern: >-
              ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
          example: 450e8400-c34f-99a9-c746-665544330000
        - name: x-cba-pi-saf
          in: header
          description: >-
            This header parameter indicates that the consumer wants the request
            processed in store and forward flow if downstream services are
            unavailable to process the request. If not provided the request will
            be processed without SAF flow.
          required: false
          schema:
            type: boolean
          example: false
        - name: x-cba-pi-saf-expiry-minutes
          in: header
          description: >-
            This header parameter indicates maximum time in minutes the consumer
            wants the request to be held in store and forward flow if downstream
            services are unavailable to process the request.
          required: false
          schema:
            type: integer
            format: int32
            minimum: 5
            maximum: 720
          example: 15
        - name: x-cba-pi-sync
          in: header
          description: >-
            This header parameter indicates the consumer wants the request
            processed synchronously with PAIN002 response. If not provided, the
            request will be processed asynchronously.
          required: false
          schema:
            type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1PaymentInitiationRequest'
            example:
              business_application_header:
                character_set: string
                from:
                  organisation_identification:
                    identification:
                      organisation_identification:
                        other:
                          - identification: SENDER_PARTICIPANT
                            scheme_name:
                              proprietary: PaymentSystemId
                          - identification: SENDER_BANK
                            scheme_name:
                              proprietary: CoreBankIdentifier
                to:
                  organisation_identification:
                    identification:
                      organisation_identification:
                        other:
                          - identification: RECEIVER_PARTICIPANT
                            scheme_name:
                              proprietary: PaymentSystemId
                          - identification: RECEIVER_BANK
                            scheme_name:
                              proprietary: CoreBankIdentifier
                business_message_identifier: sample-business-message-id-001
                message_definition_identifier: pain.001.001.11
                creation_date: '2026-03-02T12:00:00.000Z'
              business_document:
                customer_credit_transfer_initiation:
                  group_header:
                    message_identification: sample-message-id-001
                    creation_date_time: '2026-01-08T13:50:06.300Z'
                    number_of_transactions: '1'
                    initiating_party:
                      name: Example Initiating Party
                  payment_information:
                    - payment_information_identification: sample-payment-info-id-001
                      payment_method: TRF
                      payment_type_information:
                        service_level:
                          - code: INST
                      requested_execution_date:
                        date: '2026-03-24'
                      debtor:
                        name: Example Debtor
                      debtor_account:
                        identification:
                          other:
                            identification: '12345678901234'
                            scheme_name:
                              code: BBAN
                      debtor_agent:
                        financial_institution_identification:
                          clearing_system_member_identification:
                            clearing_system_identification:
                              code: AUBSB
                            member_identification: '123456'
                      credit_transfer_transaction_information:
                        - payment_identification:
                            end_to_end_identification: sample-end-to-end-id-001
                          payment_type_information:
                            category_purpose:
                              code: CASH
                          amount:
                            instructed_amount:
                              currency: AUD
                              amount: '0.10'
                          creditor_agent:
                            financial_institution_identification:
                              clearing_system_member_identification:
                                clearing_system_identification:
                                  code: AUBSB
                                member_identification: '654321'
                          creditor:
                            name: Example Creditor
                          creditor_account:
                            identification:
                              other:
                                identification: '65432101234567'
                                scheme_name:
                                  code: BBAN
                          purpose:
                            code: CASH
                          remittance_information:
                            unstructured:
                              - Sample remittance reference
      security:
        - oauth2:
            - payment-initiation.core-payments.credit-transfer-initiations.write
      responses:
        '200':
          description: The request is being processed with payment status returned.
          headers:
            Content-Type:
              schema:
                type: string
            Content-Language:
              schema:
                type: string
            x-request-id:
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerPaymentStatusReportV12Document'
              example:
                customer_payment_status_report:
                  group_header:
                    message_identification: MESSAGE_ID
                    creation_date_time: '2026-02-11T03:36:35.576058639Z'
                  original_group_information_and_status:
                    original_message_identification: ORIGINAL_MESSAGE_ID
                    original_message_name_identification: pain.001.001.11
                  original_payment_information_and_status:
                    - original_payment_information_identification: ORIGINAL_PAYMENT_INFO_ID
                      payment_information_status: ACSP
        '202':
          description: The request has been accepted for further processing.
          headers:
            Content-Type:
              schema:
                type: string
            Content-Language:
              schema:
                type: string
            x-request-id:
              schema:
                type: string
                format: uuid
        '400':
          description: Bad Request
          headers:
            Content-Type:
              schema:
                type: string
            Content-Language:
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1PaymentErrorResponse'
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
            Content-Language:
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1PaymentErrorResponse'
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
            Content-Language:
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1PaymentErrorResponse'
        '422':
          description: Idempotent request with a different request body
          headers:
            Content-Type:
              schema:
                type: string
            Content-Language:
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1PaymentErrorResponse'
        '429':
          description: Ratelimit exceeded. Refer usage guidelines.
          headers:
            Content-Type:
              schema:
                type: string
            Content-Language:
              schema:
                type: string
        '500':
          description: Internal Server Error
          headers:
            Content-Type:
              schema:
                type: string
            Content-Language:
              schema:
                type: string
            x-cba-pi-saf-retry:
              schema:
                type: boolean
                description: >-
                  Indicates whether the request can be retried with store and
                  forward processing enabled.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1PaymentErrorResponse'
        '501':
          description: Payment Initiation services not implemented for the request.
          headers:
            Content-Type:
              schema:
                type: string
            Content-Language:
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1PaymentErrorResponse'
        '503':
          description: Payment Initiation services unavailable.
          headers:
            Content-Type:
              schema:
                type: string
            Content-Language:
              schema:
                type: string
            x-cba-pi-saf-retry:
              schema:
                type: boolean
                description: >-
                  Indicates whether the request can be retried with store and
                  forward processing enabled.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1PaymentErrorResponse'
components:
  schemas:
    V1PaymentInitiationRequest:
      description: >
        The point-to-point execution message inclusive of universal
        pain.001.001.11 and head.001.001.04

        **Properties:**

        - `business_application_header`

        - `business_document`
      type: object
      properties:
        business_application_header:
          $ref: '#/components/schemas/BusinessApplicationHeaderV04'
        business_document:
          $ref: '#/components/schemas/CustomerCreditTransferInitiationV11Document'
      required:
        - business_application_header
        - business_document
    AccountIdentification4Choice:
      type: object
      description: >-
        Specifies the unique identification of an account as assigned by the
        account servicer.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            iban:
              description: >-
                International Bank Account Number (IBAN) - identifier used
                internationally by financial institutions to uniquely identify
                the account of a customer. Further specifications of the format
                and content of the IBAN can be found in the standard ISO 13616
                "Banking and related financial services - International Bank
                Account Number (IBAN)" version 1997-10-01, or later revisions.
              $ref: '#/components/schemas/IBAN2007Identifier'
          required:
            - iban
        - type: object
          additionalProperties: false
          properties:
            other:
              description: >-
                Unique identification of an account, as assigned by the account
                servicer, using an identification scheme.
              $ref: '#/components/schemas/GenericAccountIdentification1'
          required:
            - other
    AccountSchemeName1Choice:
      type: object
      description: Sets of elements to identify a name of the identification scheme.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Name of the identification scheme, in a coded form as published
                in an external list.
              $ref: '#/components/schemas/ExternalAccountIdentification1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Name of the identification scheme, in a free text form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    ActiveCurrencyAndAmount:
      type: object
      description: >-
        A number of monetary units specified in an active currency where the
        unit of currency is explicit and compliant with ISO 4217.
      additionalProperties: false
      properties:
        currency:
          $ref: '#/components/schemas/ActiveCurrencyCode'
        amount:
          type: string
          maxLength: 19
          pattern: >-
            ^0*(([0-9]{0,13}\.[0-9]{1,5})|([0-9]{0,14}\.[0-9]{1,4})|([0-9]{0,15}\.[0-9]{1,3})|([0-9]{0,16}\.[0-9]{1,2})|([0-9]{0,17}\.[0-9]{1,1})|([0-9]{0,18}\.)|0*|([0-9]{0,18}))$
      required:
        - currency
        - amount
    ActiveCurrencyCode:
      type: string
      pattern: ^[A-Z]{3,3}$
      description: >-
        A code allocated to a currency by a Maintenance Agency under an
        international identification scheme as described in the latest edition
        of the international standard ISO 4217 "Codes for the representation of
        currencies and funds".
    ActiveOrHistoricCurrencyAndAmount:
      type: object
      description: >-
        A number of monetary units specified in an active or a historic currency
        where the unit of currency is explicit and compliant with ISO 4217.
      additionalProperties: false
      properties:
        currency:
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
        amount:
          type: string
          format: pattern
          maxLength: 19
          pattern: >-
            ^0*(([0-9]{0,13}\.[0-9]{1,5})|([0-9]{0,14}\.[0-9]{1,4})|([0-9]{0,15}\.[0-9]{1,3})|([0-9]{0,16}\.[0-9]{1,2})|([0-9]{0,17}\.[0-9]{1,1})|([0-9]{0,18}\.)|0*|([0-9]{0,18}))$
      required:
        - currency
        - amount
    ActiveOrHistoricCurrencyCode:
      type: string
      format: pattern
      pattern: ^[A-Z]{3,3}$
      description: >-
        A code allocated to a currency by a Maintenance Agency under an
        international identification scheme, as described in the latest edition
        of the international standard ISO 4217 "Codes for the representation of
        currencies and funds".
    AddressType2Code:
      type: string
      description: |-
        Specifies the type of address.
        *`ADDR`-Address is the complete postal address.
        *`PBOX`-Address is a postal office (PO) box.
        *`HOME`-Address is the home address.
        *`BIZZ`-Address is the business address.
        *`MLTO`-Address is the address to which mail is sent.
        *`DLVY`-Address is the address to which delivery is to take place.
      enum:
        - ADDR
        - PBOX
        - HOME
        - BIZZ
        - MLTO
        - DLVY
    AddressType3Choice:
      type: object
      description: Choice of formats for the type of address.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: Type of address expressed as a code.
              $ref: '#/components/schemas/AddressType2Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Type of address expressed as a proprietary code.
              $ref: '#/components/schemas/GenericIdentification30'
          required:
            - proprietary
    AmendmentInformationDetails14:
      type: object
      description: >-
        Provides further details on the list of direct debit mandate elements
        that have been modified when the amendment indicator has been set.
      additionalProperties: false
      properties:
        original_mandate_identification:
          description: >-
            Unique identification, as assigned by the creditor, to unambiguously
            identify the original mandate.
          $ref: '#/components/schemas/Max35Text'
        original_creditor_scheme_identification:
          description: Original creditor scheme identification that has been modified.
          $ref: '#/components/schemas/PartyIdentification135'
        original_creditor_agent:
          description: Original creditor agent that has been modified.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        original_creditor_agent_account:
          description: Original creditor agent account that has been modified.
          $ref: '#/components/schemas/CashAccount40'
        original_debtor:
          description: Original debtor that has been modified.
          $ref: '#/components/schemas/PartyIdentification135'
        original_debtor_account:
          description: Original debtor account that has been modified.
          $ref: '#/components/schemas/CashAccount40'
        original_debtor_agent:
          description: Original debtor agent that has been modified.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        original_debtor_agent_account:
          description: Original debtor agent account that has been modified.
          $ref: '#/components/schemas/CashAccount40'
        original_final_collection_date:
          description: Original final collection date that has been modified.
          $ref: '#/components/schemas/ISODate'
        original_frequency:
          description: Original frequency that has been modified.
          $ref: '#/components/schemas/Frequency36Choice'
        original_reason:
          description: >-
            Original reason for the mandate to allow the user to distinguish
            between different mandates for the same creditor.
          $ref: '#/components/schemas/MandateSetupReason1Choice'
        original_tracking_days:
          description: Original number of tracking days that has been modified.
          $ref: '#/components/schemas/Exact2NumericText'
    AmountType4Choice:
      type: object
      description: >-
        Specifies the amount of money to be moved between the debtor and
        creditor, before deduction of charges, expressed in the currency as
        ordered by the initiating party.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            instructed_amount:
              description: >-
                Amount of money to be moved between the debtor and creditor,
                before deduction of charges, expressed in the currency as
                ordered by the initiating party.  Usage: This amount has to be
                transported unchanged through the transaction chain.
              $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
          required:
            - instructed_amount
        - type: object
          additionalProperties: false
          properties:
            equivalent_amount:
              description: >-
                Amount of money to be moved between the debtor and creditor,
                expressed in the currency of the debtor's account, and the
                currency in which the amount is to be moved.
              $ref: '#/components/schemas/EquivalentAmount2'
          required:
            - equivalent_amount
    AnyBICDec2014Identifier:
      type: string
      description: >-
        Code allocated to a financial or non-financial institution by the ISO
        9362 Registration Authority, as described in ISO 9362: 2014 - "Banking -
        Banking telecommunication messages - Business identifier code (BIC)".
      pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$
    BICFIDec2014Identifier:
      type: string
      description: >-
        Code allocated to a financial institution by the ISO 9362 Registration
        Authority as described in ISO 9362: 2014 - "Banking - Banking
        telecommunication messages - Business identifier code (BIC)".
      pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$
    BaseOneRate:
      type: string
      description: Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.
      maxLength: 12
    BranchAndFinancialInstitutionIdentification6:
      type: object
      description: >-
        Unique and unambiguous identification of a financial institution or a
        branch of a financial institution.
      additionalProperties: false
      properties:
        financial_institution_identification:
          description: >-
            Unique and unambiguous identification of a financial institution, as
            assigned under an internationally recognised or proprietary
            identification scheme.
          $ref: '#/components/schemas/FinancialInstitutionIdentification18'
        branch_identification:
          description: >-
            Identifies a specific branch of a financial institution.  Usage:
            This component should be used in case the identification information
            in the financial institution component does not provide
            identification up to branch level.
          $ref: '#/components/schemas/BranchData3'
      required:
        - financial_institution_identification
    BranchData3:
      type: object
      description: >-
        Information that locates and identifies a specific branch of a financial
        institution.
      additionalProperties: false
      properties:
        identification:
          description: >-
            Unique and unambiguous identification of a branch of a financial
            institution.
          $ref: '#/components/schemas/Max35Text'
        lei:
          description: >-
            Legal entity identification for the branch of the financial
            institution.
          $ref: '#/components/schemas/LEIIdentifier'
        name:
          description: >-
            Name by which an agent is known and which is usually used to
            identify that agent.
          $ref: '#/components/schemas/Max140Text'
        postal_address:
          description: >-
            Information that locates and identifies a specific address, as
            defined by postal services.
          $ref: '#/components/schemas/PostalAddress24'
    CashAccount40:
      type: object
      description: Provides the details to identify an account.
      additionalProperties: false
      properties:
        identification:
          description: >-
            Unique and unambiguous identification for the account between the
            account owner and the account servicer.
          $ref: '#/components/schemas/AccountIdentification4Choice'
        type:
          description: Specifies the nature, or use of the account.
          $ref: '#/components/schemas/CashAccountType2Choice'
        currency:
          description: >-
            Identification of the currency in which the account is held.  
            Usage: Currency should only be used in case one and the same account
            number covers several currencies and the initiating party needs to
            identify which currency needs to be used for settlement on the
            account.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
        name:
          description: >-
            Name of the account, as assigned by the account servicing
            institution, in agreement with the account owner in order to provide
            an additional means of identification of the account.  Usage: The
            account name is different from the account owner name. The account
            name is used in certain user communities to provide a means of
            identifying the account, in addition to the account owner's identity
            and the account number.
          $ref: '#/components/schemas/Max70Text'
        proxy:
          description: >-
            Specifies an alternate assumed name for the identification of the
            account. 
          $ref: '#/components/schemas/ProxyAccountIdentification1'
    CashAccountType2Choice:
      type: object
      description: Nature or use of the account.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: Account type, in a coded form.
              $ref: '#/components/schemas/ExternalCashAccountType1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Nature or use of the account in a proprietary form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    CategoryPurpose1Choice:
      type: object
      description: >-
        Specifies the high level purpose of the instruction based on a set of
        pre-defined categories.

        Usage: This is used by the initiating party to provide information
        concerning the processing of the payment. It is likely to trigger
        special processing by any of the agents involved in the payment chain.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Category purpose, as published in an external category purpose
                code list.
              $ref: '#/components/schemas/ExternalCategoryPurpose1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Category purpose, in a proprietary form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    ChargeBearerType1Code:
      type: string
      description: >-
        Specifies which party(ies) will pay charges due for processing of the
        instruction.

        *`DEBT`-All transaction charges are to be borne by the debtor.

        *`CRED`-All transaction charges are to be borne by the creditor.

        *`SHAR`-In a credit transfer context, means that transaction charges on
        the sender side are to be borne by the debtor, transaction charges on
        the receiver side are to be borne by the creditor. In a direct debit
        context, means that transaction charges on the sender side are to be
        borne by the creditor, transaction charges on the receiver side are to
        be borne by the debtor.

        *`SLEV`-Charges are to be applied following the rules agreed in the
        service level and/or scheme.
      enum:
        - DEBT
        - CRED
        - SHAR
        - SLEV
    Charges7:
      type: object
      description: Provides information on the charges related to the payment transaction.
      additionalProperties: false
      properties:
        amount:
          description: Transaction charges to be paid by the charge bearer.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        agent:
          description: >-
            Agent that takes the transaction charges or to which the transaction
            charges are due.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
      required:
        - amount
        - agent
    ClearingChannel2Code:
      type: string
      description: >-
        Specifies the clearing channel for the routing of the transaction, as
        part of the payment type identification.

        *`RTGS`-Clearing channel is a real-time gross settlement system.

        *`RTNS`-Clearing channel is a real-time net settlement system.

        *`MPNS`-Clearing channel is a mass payment net settlement system.

        *`BOOK`-Payment through internal book transfer.
      enum:
        - RTGS
        - RTNS
        - MPNS
        - BOOK
    ClearingSystemIdentification2Choice:
      type: object
      description: Choice of a clearing system identifier.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Identification of a clearing system, in a coded form as
                published in an external list.
              $ref: '#/components/schemas/ExternalClearingSystemIdentification1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: >-
                Identification code for a clearing system, that has not yet been
                identified in the list of clearing systems.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    ClearingSystemIdentification3Choice:
      type: object
      description: Specifies the clearing system identification.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Infrastructure through which the payment instruction is
                processed, as published in an external clearing system
                identification code list.
              $ref: '#/components/schemas/ExternalCashClearingSystem1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Clearing system identification in a proprietary form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    ClearingSystemMemberIdentification2:
      type: object
      description: >-
        Unique identification, as assigned by a clearing system, to
        unambiguously identify a member of the clearing system.
      additionalProperties: false
      properties:
        clearing_system_identification:
          description: >-
            Specification of a pre-agreed offering between clearing agents or
            the channel through which the payment instruction is processed.
          $ref: '#/components/schemas/ClearingSystemIdentification2Choice'
        member_identification:
          description: Identification of a member of a clearing system.
          $ref: '#/components/schemas/Max35Text'
      required:
        - member_identification
    Contact4:
      type: object
      description: Specifies the details of the contact person.
      additionalProperties: false
      properties:
        name_prefix:
          description: Specifies the terms used to formally address a person.
          $ref: '#/components/schemas/NamePrefix2Code'
        name:
          description: >-
            Name by which a party is known and which is usually used to identify
            that party.
          $ref: '#/components/schemas/Max140Text'
        phone_number:
          description: >-
            Collection of information that identifies a phone number, as defined
            by telecom services.
          $ref: '#/components/schemas/PhoneNumber'
        mobile_number:
          description: >-
            Collection of information that identifies a mobile phone number, as
            defined by telecom services.
          $ref: '#/components/schemas/PhoneNumber'
        fax_number:
          description: >-
            Collection of information that identifies a FAX number, as defined
            by telecom services.
          $ref: '#/components/schemas/PhoneNumber'
        email_address:
          description: Address for electronic mail (e-mail).
          $ref: '#/components/schemas/Max2048Text'
        email_purpose:
          description: Purpose for which an email address may be used.
          $ref: '#/components/schemas/Max35Text'
        job_title:
          description: Title of the function.
          $ref: '#/components/schemas/Max35Text'
        responsibility:
          description: Role of a person in an organisation.
          $ref: '#/components/schemas/Max35Text'
        department:
          description: Identification of a division of a large organisation or building.
          $ref: '#/components/schemas/Max70Text'
        other:
          type: array
          description: Contact details in another form.
          items:
            $ref: '#/components/schemas/OtherContact1'
        preferred_method:
          description: Preferred method used to reach the contact.
          $ref: '#/components/schemas/PreferredContactMethod1Code'
    CountryCode:
      type: string
      pattern: ^[A-Z]{2,2}$
      description: >-
        Code to identify a country, a dependency, or another area of particular
        geopolitical interest, on the basis of country names obtained from the
        United Nations (ISO 3166, Alpha-2 code).
    CreditDebitCode:
      type: string
      description: |-
        Specifies if an operation is an increase or a decrease.
        *`CRDT`-Operation is an increase.
        *`DBIT`-Operation is a decrease.
      enum:
        - CRDT
        - DBIT
    CreditTransferMandateData1:
      type: object
      description: >-
        Provides further details related to a credit transfer mandate signed
        between the creditor and the debtor.
      additionalProperties: false
      properties:
        mandate_identification:
          description: >-
            Unique identification, as assigned by the creditor, to unambiguously
            identify the mandate.
          $ref: '#/components/schemas/Max35Text'
        type:
          description: Specifies the type of mandate, such as paper, electronic or scheme.
          $ref: '#/components/schemas/MandateTypeInformation2'
        date_of_signature:
          description: >-
            Date on which the credit transfer mandate has been signed by the
            debtor.
          $ref: '#/components/schemas/ISODate'
        date_of_verification:
          description: Date on which the credit transfer mandate has been verified.
          $ref: '#/components/schemas/ISODateTime'
        electronic_signature:
          description: >-
            Additional security provisions, such as a digital signature, as
            provided by the debtor.
          $ref: '#/components/schemas/Max10KBinary'
        first_payment_date:
          description: >-
            Date of the first payment of a recurrent credit transfer as per the
            mandate.
          $ref: '#/components/schemas/ISODate'
        final_payment_date:
          description: >-
            Date of the final payment of a recurrent credit transfer as per the
            mandate.
          $ref: '#/components/schemas/ISODate'
        frequency:
          description: >-
            Regularity with which credit transfer instructions are to be created
            and processed.
          $ref: '#/components/schemas/Frequency36Choice'
        reason:
          description: >-
            Reason for the setup of the credit transfer mandate.  Usage:  The
            reason will allow the user to distinguish between different mandates
            for the same creditor.
          $ref: '#/components/schemas/MandateSetupReason1Choice'
    CreditorReferenceInformation2:
      type: object
      description: >-
        Reference information provided by the creditor to allow the
        identification of the underlying documents.
      additionalProperties: false
      properties:
        type:
          description: Specifies the type of creditor reference.
          $ref: '#/components/schemas/CreditorReferenceType2'
        reference:
          description: >-
            Unique reference, as assigned by the creditor, to unambiguously
            refer to the payment transaction.  Usage: If available, the
            initiating party should provide this reference in the structured
            remittance information, to enable reconciliation by the creditor
            upon receipt of the amount of money.  If the business context
            requires the use of a creditor reference or a payment remit
            identification, and only one identifier can be passed through the
            end-to-end chain, the creditor's reference or payment remittance
            identification should be quoted in the end-to-end transaction
            identification.
          $ref: '#/components/schemas/Max35Text'
    CreditorReferenceType1Choice:
      type: object
      description: Specifies the type of document referred by the creditor.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: Type of creditor reference, in a coded form.
              $ref: '#/components/schemas/DocumentType3Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Creditor reference type, in a proprietary form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    CreditorReferenceType2:
      type: object
      description: Specifies the type of creditor reference.
      additionalProperties: false
      properties:
        code_or_proprietary:
          description: Coded or proprietary format creditor reference type.
          $ref: '#/components/schemas/CreditorReferenceType1Choice'
        issuer:
          description: Entity that assigns the credit reference type.
          $ref: '#/components/schemas/Max35Text'
      required:
        - code_or_proprietary
    CurrencyExchange13:
      type: object
      description: Describes the details of the currency exchange.
      additionalProperties: false
      properties:
        source_currency:
          description: >-
            Currency from which an amount is to be converted in a currency
            conversion.
          $ref: '#/components/schemas/ActiveCurrencyCode'
        target_currency:
          description: >-
            Currency into which an amount is to be converted in a currency
            conversion.
          $ref: '#/components/schemas/ActiveCurrencyCode'
        exchange_rate:
          description: >-
            Factor used to convert an amount from one currency into another.
            This reflects the price at which one currency was bought with
            another currency.
          $ref: '#/components/schemas/BaseOneRate'
        unit_currency:
          description: >-
            Currency in which the rate of exchange is expressed in a currency
            exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
          $ref: '#/components/schemas/ActiveCurrencyCode'
      required:
        - source_currency
        - target_currency
        - exchange_rate
    CustomerPaymentStatusReportV12Document:
      description: CustomerPaymentStatusReportV12 Document
      type: object
      required:
        - customer_payment_status_report
      additionalProperties: false
      properties:
        customer_payment_status_report:
          $ref: '#/components/schemas/CustomerPaymentStatusReportV12'
    CustomerPaymentStatusReportV12:
      type: object
      description: >-
        **Scope**


        The CustomerPaymentStatusReport message is sent by an instructed agent
        to the previous party in the payment chain. It is used to inform this
        party about the positive or negative status of an instruction (either
        single or file). It is also used to report on a pending instruction.


        **Usage**


        The CustomerPaymentStatusReport message is exchanged between an agent
        and a non-financial institution customer to provide status information
        on instructions previously sent. Its usage will always be governed by a
        bilateral agreement between the agent and the non-financial institution
        customer.


        The CustomerPaymentStatusReport message can be used to provide
        information about the status (for example a rejection, an acceptance) of
        the initiation of a credit transfer, a direct debit, as well as on the
        initiation of other customer instructions.


        The CustomerPaymentStatusReport message refers to the original
        instruction(s) by means of references only or by means of references and
        a set of elements from the original instruction.


        The CustomerPaymentStatusReport message can be used in domestic and
        cross-border scenarios.


        The CustomerPaymentStatusReport may also be sent to the receiver of the
        payment in a real time payment scenario, as both sides of the
        transactions must be informed of the status of the transaction (that is
        either the beneficiary is credited, or the transaction is rejected).
      additionalProperties: false
      properties:
        group_header:
          description: >-
            Set of characteristics shared by all individual transactions
            included in the status report message.
          $ref: '#/components/schemas/GroupHeader86'
        original_group_information_and_status:
          description: >-
            Original group information concerning the group of transactions, to
            which the status report message refers to.
          $ref: '#/components/schemas/OriginalGroupHeader17'
        original_payment_information_and_status:
          type: array
          description: >-
            Information concerning the original payment information, to which
            the status report message refers.
          items:
            $ref: '#/components/schemas/OriginalPaymentInstruction40'
        supplementary_data:
          type: array
          description: >-
            Additional information that cannot be captured in the structured
            elements and/or any other specific block.
          items:
            $ref: '#/components/schemas/SupplementaryData1'
      required:
        - group_header
        - original_group_information_and_status
    DateAndDateTime2Choice:
      type: object
      description: Choice between a date or a date and time format.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            date:
              description: Specified date.
              $ref: '#/components/schemas/ISODate'
          required:
            - date
        - type: object
          additionalProperties: false
          properties:
            date_time:
              description: Specified date and time.
              $ref: '#/components/schemas/ISODateTime'
          required:
            - date_time
    DateAndPlaceOfBirth1:
      type: object
      description: Date and place of birth of a person.
      additionalProperties: false
      properties:
        birth_date:
          description: Date on which a person is born.
          $ref: '#/components/schemas/ISODate'
        province_of_birth:
          description: Province where a person was born.
          $ref: '#/components/schemas/Max35Text'
        city_of_birth:
          description: City where a person was born.
          $ref: '#/components/schemas/Max35Text'
        country_of_birth:
          description: Country where a person was born.
          $ref: '#/components/schemas/CountryCode'
      required:
        - birth_date
        - city_of_birth
        - country_of_birth
    DatePeriod2:
      type: object
      description: Range of time defined by a start date and an end date.
      additionalProperties: false
      properties:
        from_date:
          description: Start date of the range.
          $ref: '#/components/schemas/ISODate'
        to_date:
          description: End date of the range.
          $ref: '#/components/schemas/ISODate'
      required:
        - from_date
        - to_date
    DecimalNumber:
      type: string
      description: >-
        Number of objects represented as a decimal number, for example 0.75 or
        45.6.
      maxLength: 19
    DiscountAmountAndType1:
      type: object
      description: Specifies the amount with a specific type.
      additionalProperties: false
      properties:
        type:
          description: Specifies the type of the amount.
          $ref: '#/components/schemas/DiscountAmountType1Choice'
        amount:
          description: Amount of money, which has been typed.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
      required:
        - amount
    DiscountAmountType1Choice:
      type: object
      description: Specifies the amount type.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: Specifies the amount type, in a coded form.
              $ref: '#/components/schemas/ExternalDiscountAmountType1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Specifies the amount type, in a free-text form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    DocumentAdjustment1:
      type: object
      description: >-
        Set of elements used to provide information on the amount and reason of
        the document adjustment.
      additionalProperties: false
      properties:
        amount:
          description: Amount of money of the document adjustment.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        credit_debit_indicator:
          description: >-
            Specifies whether the adjustment must be subtracted or added to the
            total amount.
          $ref: '#/components/schemas/CreditDebitCode'
        reason:
          description: Specifies the reason for the adjustment.
          $ref: '#/components/schemas/Max4Text'
        additional_information:
          description: Provides further details on the document adjustment.
          $ref: '#/components/schemas/Max140Text'
      required:
        - amount
    DocumentLineIdentification1:
      type: object
      description: Identifies the documents referred to in the remittance information.
      additionalProperties: false
      properties:
        type:
          description: Specifies the type of referred document line identification.
          $ref: '#/components/schemas/DocumentLineType1'
        number:
          description: Identification of the type specified for the referred document line.
          $ref: '#/components/schemas/Max35Text'
        related_date:
          description: Date associated with the referred document line.
          $ref: '#/components/schemas/ISODate'
    DocumentLineInformation1:
      type: object
      description: Provides document line information.
      additionalProperties: false
      properties:
        identification:
          type: array
          description: Provides identification of the document line.
          items:
            $ref: '#/components/schemas/DocumentLineIdentification1'
        description:
          description: Description associated with the document line.
          $ref: '#/components/schemas/Max2048Text'
        amount:
          description: Provides details on the amounts of the document line.
          $ref: '#/components/schemas/RemittanceAmount3'
      required:
        - identification
    DocumentLineType1:
      type: object
      description: Specifies the type of the document line identification.
      additionalProperties: false
      properties:
        code_or_proprietary:
          description: >-
            Provides the type details of the referred document line
            identification.
          $ref: '#/components/schemas/DocumentLineType1Choice'
        issuer:
          description: >-
            Identification of the issuer of the reference document line
            identificationtype.
          $ref: '#/components/schemas/Max35Text'
      required:
        - code_or_proprietary
    DocumentLineType1Choice:
      type: object
      description: Specifies the type of the document line identification.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: Line identification type in a coded form.
              $ref: '#/components/schemas/ExternalDocumentLineType1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: >-
                Proprietary identification of the type of the remittance
                document.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    DocumentType3Code:
      type: string
      description: >-
        Specifies a type of financial or commercial document.

        *`RADM`-Document is a remittance advice sent separately from the current
        transaction.

        *`RPIN`-Document is a linked payment instruction to which the current
        payment instruction is related, for example, in a cover scenario.

        *`FXDR`-Document is a pre-agreed or pre-arranged foreign exchange
        transaction to which the payment transaction refers.

        *`DISP`-Document is a dispatch advice.

        *`PUOR`-Document is a purchase order.

        *`SCOR`-Document is a structured communication reference provided by the
        creditor to identify the referred transaction.
      enum:
        - RADM
        - RPIN
        - FXDR
        - DISP
        - PUOR
        - SCOR
    DocumentType6Code:
      type: string
      description: >-
        Specifies a type of financial or commercial document.

        *`MSIN`-Document is an invoice claiming payment for the supply of
        metered services, for example gas or electricity supplied to a fixed
        meter.

        *`CNFA`-Document is a credit note for the final amount settled for a
        commercial transaction.

        *`DNFA`-Document is a debit note for the final amount settled for a
        commercial transaction.

        *`CINV`-Document is an invoice.

        *`CREN`-Document is a credit note.

        *`DEBN`-Document is a debit note.

        *`HIRI`-Document is an invoice for the hiring of human resources or
        renting goods or equipment.

        *`SBIN`-Document is an invoice issued by the debtor.

        *`CMCN`-Document is an agreement between the parties, stipulating the
        terms and conditions of the delivery of goods or services.

        *`SOAC`-Document is a statement of the transactions posted to the
        debtor's account at the supplier.

        *`DISP`-Document is a dispatch advice.

        *`BOLD`-Document is a shipping notice.

        *`VCHR`-Document is an electronic payment document.

        *`AROI`-Document is a payment that applies to a specific source
        document.

        *`TSUT`-Document is a transaction identifier as assigned by the Trade
        Services Utility.

        *`PUOR`-Document is a purchase order.
      enum:
        - MSIN
        - CNFA
        - DNFA
        - CINV
        - CREN
        - DEBN
        - HIRI
        - SBIN
        - CMCN
        - SOAC
        - DISP
        - BOLD
        - VCHR
        - AROI
        - TSUT
        - PUOR
    EquivalentAmount2:
      type: object
      description: >-
        Amount of money to be moved between the debtor and creditor, expressed
        in the currency of the debtor's account, and the currency in which the
        amount is to be moved.
      additionalProperties: false
      properties:
        amount:
          description: >-
            Amount of money to be moved between debtor and creditor, before
            deduction of charges, expressed in the currency of the debtor's
            account, and to be moved in a different currency. Usage: The first
            agent will convert the equivalent amount into the amount to be
            moved.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        currency_of_transfer:
          description: >-
            Specifies the currency of the to be transferred amount, which is
            different from the currency of the debtor's account.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
      required:
        - amount
        - currency_of_transfer
    Exact2NumericText:
      type: string
      description: Specifies a numeric string with an exact length of 2 digits.
      pattern: ^[0-9]{2}$
    Exact4AlphaNumericText:
      type: string
      description: Specifies an alphanumeric string with a length of 4 characters.
      pattern: ^[a-zA-Z0-9]{4}$
    ExternalAccountIdentification1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\r\nThe list of valid codes is an external code list published separately.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`AIIN`-Issuer Identification Number (IIN) - identifies a card issuing institution in an international interchange environment. Issued by ABA (American Bankers Association).\n*`BBAN`-Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.\n*`CUID`-(United States) Clearing House Interbank Payments System (CHIPS) Universal Identification (UID) - identifies entities that own accounts at CHIPS participating financial institutions, through which CHIPS payments are effected. The CHIPS UID is assigned by the New York Clearing House.\n*`UPIC`-Universal Payment Identification Code (UPIC) - identifier used by the New York Clearing House to mask confidential data, such as bank accounts and bank routing numbers. UPIC numbers remain with business customers, regardless of banking relationship changes."
      enum:
        - AIIN
        - BBAN
        - CUID
        - UPIC
    ExternalCashAccountType1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\r\nThe list of valid codes is an external code list published separately.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`CACC`-Account used to post debits and credits when no specific account has been nominated.\n*`CARD`-Account used for credit card payments.\n*`CASH`-Account used for the payment of cash.\n*`CHAR`-Account used for charges if different from the account for\npayment.\n*`CISH`-Account used for payment of income if different from the current cash account\n*`COMM`-Account used for commission if different from the account\nfor payment.\n*`CPAC`-Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.\n*`LLSV`-Account used for savings with special interest and withdrawal terms.  \n*`LOAN`-Account used for loans.\n*`MGLD`-Account used for a marginal lending facility.\n*`MOMA`-Account used for money markets if different from the cash\naccount.\n*`NREX`-Account used for non-resident external.\n*`ODFT`-Account is used for overdrafts.\n*`ONDP`-Account used for overnight deposits.\n*`OTHR`-Account not otherwise specified. \n*`SACC`-Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.\n*`SLRY`-Accounts used for salary payments.\n*`SVGS`-Account used for savings.\n*`TAXE`-Account used for taxes if different from the account for\npayment.\n*`TRAN`-A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.\n*`TRAS`-Account used for trading if different from the current cash account.\n*`VACC`-Account created virtually to facilitate collection and reconciliation.\n*`NFCA`-Non-Resident Individual / Entity Foreign Current held domestically.\n*`RFCA`-Resident Individual Foreign Currency held domestically.\n*`REFC`-Resident Entity Foreign Currency held domestically.\n*`NLCY`-Non-Resident domestic currency account.\n*`RLCY`-Resident domestic currency account."
      enum:
        - CACC
        - CARD
        - CASH
        - CHAR
        - CISH
        - COMM
        - CPAC
        - LLSV
        - LOAN
        - MGLD
        - MOMA
        - NREX
        - ODFT
        - ONDP
        - OTHR
        - SACC
        - SLRY
        - SVGS
        - TAXE
        - TRAN
        - TRAS
        - VACC
        - NFCA
        - RFCA
        - REFC
        - NLCY
        - RLCY
    ExternalCashClearingSystem1Code:
      type: string
      minLength: 1
      maxLength: 3
      description: "Specifies the cash clearing system, as published in an external cash clearing system code list.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`ABE`-EBA Euro1/Step1.\n*`ACH`-Automated Clearing House. Payment system that clears cash transfers and settles the proceeds in a lump sum, usually on a multilateral netting basis.\n*`ACS`-Canadian Dollar (CAD)  - Automated Clearing Settlement System (ACSS) \n*`AIP`-AL (Albania) -  Albania Interbank Payment System.\n*`ART`-AT (Austria) - Austrian RTGS.\n*`AVP`-NZ (New Zealand) - New Zealand Assured Value Payments.\n*`AZM`-AZ (Azerbaijan) - Azerbaijan Interbank Payment System (AZIPS).\n*`BAP`-BA (Bosnia and Herzegovina).\n*`BCC`-SE (Sweden) - Sweden BGC Clearing CUG.\n*`BCE`-EC (Ecuador) - Ecuadorian\_Central\_Payment System (Sistema Central de Pagos Ecuatoriano)\n*`BDS`-BB (Barbados) - Barbados RTGS (CBRTGS).\n*`BEL`-BE (Belgium) - Belgium RTGS (ELLIPS).\n*`BGN`-BG (Bulgaria) - Bulgaria RTGS.\n*`BHS`-BS (Bahamas) - Bahamas RTGS.\n*`BIS`-BW (Botswana) - Botswana Interbank Settlement System.\n*`BOF`-FI (Finland) - RTGS (BOF).\n*`BOJ`-the Bank of Japan clearing system.\n*`BRL`-IT (Italy) - Italy RTGS (BIREL).\n*`BSP`-PH (Philippines) - Philippines Payment System.\n*`CAD`-CA (Canada) - Canadian Large Value Transfer System (LVTS)\n*`CAM`-ES (Spain).\n*`CBA`-AW (Aruba) - Central Bank of Aruba CSM\n*`CBC`-CW (Curaçao), SX (Sint Maarten) Central Bank of Curaçao and Sint    Maarten CSM\n*`CBJ`-IE (Ireland) - Irish RTGS (IRIS).\n*`CCE`-Real-Time Payment System Peru\n*`CHI`-US - The Clearing House CHIPS\n*`CHP`-GB (UK) - British Euro RTGS (CHAPS).\n*`CIP`-Cross-border Interbank Payment System (CIPS) \n*`CIS`-Central Interoperability Service of the EACHA Clearing Cooperative, for exchanging SEPA payments between Automated Clearing Houses in the EEA.\n*`COE`-CO (Columbia) - Colombian Electronic Cheque System named CEDEC (Compensación Electrónica De Cheques).\n*`COI`-CO (Columbia) - Colombian Central Bank´s ACH named CENIT (Compensación Electrónica Nacional Interbancaria).\n*`COU`-CO (Columbia) - Colombian RTGS System named CUD (Cuentas de Depósito).\n*`DDK`-DK (Denmark) - Danish Krone RTGS (KRONOS)\n*`DKC`-DK (Denmark) - Danish Euro RTGS (KRONOS)\n*`EBA`-EBA Euro1.\n*`ELS`-DE (Germany).\n*`EMZ`-Elektronischer Massenzahlungsverkehr (EMZ)\nDE (Germany) – retail payment system operated by the Deutsche Bundesbank \n*`EPM`-ECB (European Central Bank) - ECB Payment Mechanism.\n*`EPN`-US - The Clearing House EPN\n*`ERP`-EBA step 1 (members).\n*`FDA`-US (United States) - Federal Reserve Banks Automated Clearing House Service.\n*`FDN`-US (United States) - Federal Reserve Banks FedNow Service.\n*`FDW`-US (United States) - Federal Reserve Banks Fedwire Funds  Service.\n*`FEY`-JP (Japan) the Foreign Exchange Yen Clearing system (FEYCS). It is the Japanese electronic interbank system for sending guaranteed and unconditional yen payments of FX deals for same day settlement from one settlement bank, on behalf of itself or its customers, to another settlement bank.\n*`FPS`-Faster Payments Service in UK.\n*`GIS`-GH (Ghana) - Ghana Interbank Settlement System (GISS).\n*`HKL`-Hong Kong Clearing House Automated Transfer System (CHATS).\n*`HKS`-Hong Kong Faster Payment System or FPS. A system owned and operated by the HKICL, to provide instant clearing and settlement payment services.\n*`HRK`-HR (Croatia) - HSVP.\n*`HRM`-GR (Greece) - Greek RTGS (HERMES).\n*`HUF`-HU (Hungary) - VIBER.\n*`IBP`-ES - Spain - Iberpay Instant Payments\n*`INC`-DE and NL - Equens \n*`IMP`-India Immediate Payment Service\n*`JOD`-JO (Jordan) - Jordan RTGS.\n*`KPS`-KE (Kenya) - Kenyan Electronic Payment Settlement System.\n*`LGS`-LU (Luxemburg) - Luxembourg RTGS (LIPS).\n*`LKB`-LK (Sri Lanka) - Sri Lanka (Lankasettle).\n*`LVL`-LV (Latvia).\n*`LVT`-CA (Canada) - Large Value Transfer System (LVTS).\n*`LYX`-CA (Canada) Lynx High Value Payment System.\n*`MEP`-SG (Singapore) - Singapore RTGS (MEPS+).\n*`MOS`-ZA (South Africa) - South-African Multiple Option Settlement.\n*`MQQ`-Macao Real Time Gross Settlement System\n*`MRS`-MT (Malta) - Malta Realtime Interbank Settlement System.\n*`MUP`-MU (Mauritius).\n*`NAM`-NA (Namibian) - Namibian Interbank Settlement System.\n*`NOC`-NO (Norway).\n*`NOR`-NICS Real (Norway)\n*`NPP`-AU (Australia) - New Payments Platform (NPP).\n*`NSS`-US (United States) - Federal Reserve Banks National Settlement Service.\n*`NZE`-NZ (New Zealand) – New Zealand Dollar RTGS (ESAS)\n*`PCH`-CH (Switzerland).\n*`PDS`-AU (Australia).\n*`PEG`-EG (Egypt).\n*`PNS`-FR (France).\n*`PSA`-AT (Austria) – Austrian CSM.\n*`PTR`-AO (Angola) - Angola RTGS.\n*`PVE`-Ve (Venezuela).\n*`ROL`-RO (Romania) - Romanian Electronic Payment Operations RT.\n*`ROS`-RO (Romania) - Romanian GSRS.\n*`RTG`-Real Time Gross Settlement System. Payment system that simultaneously clears individual transfers and settles them in central bank money.\n*`RTP`-DE (Germany).\n*`RTR`-CA (Canada) Real Time Rail Payment System.\n*`SCL`-DE – SEPA-Clearer of the Retail Payment System operated by Deutsche Bundesbank\n*`SCP`-CL (Chile) - Chilean Interbank Payment System.\n*`SEC`-SE (Sweden) - Swedish Euro RTGS (SEC).\n*`SEU`-CH (Switzerland) – Swiss EUR RTGS named euroSIC.\n*`SIC`-CH (Switzerland) – Swiss CHF RTGS named SIC.\n*`SIP`-CH (Switzerland) – Swiss Instant Payment service in CHF operated by SIX Interbank Clearing.\n*`SIT`-SI (Slovenia).\n*`SLB`-ES (Spain) - Spanish RTGS (SLBE).\n*`SPG`-PT (Portugal) - Portuguese RTGS (SPGT).\n*`SSK`-SE (Sweden) - SEK RTGS (RIX).\n*`ST2`-EBA Clearing STEP 2.\n*`STG`-UK (United Kingdom) - CHAPS Sterling RTGS.\n*`TBF`-FR (France) - French RTGS (TBF).\n*`TCH`-US - The Clearing House Real-TimePayment System\n*`TGT`-Target.\n*`THB`-TH (Thailand) - Thailand Payment System (BAHTNET).\n*`THN`-TH (Thailand) - National ITMX Payment System\n*`TIS`-TZ (Tanzania) - Tanzania Interbank Settlement System (TISS).\n*`TOP`-NL (Netherlands) - Dutch RTGS (TOP) \n*`TTD`-TT (Trinidad and Tobago ) - Trinidad and Tobago SAFE-TT.\n*`UBE`-United States Dollar  (USD) – US Bulk Exchange Clearing System (USBE)\n*`UIS`-UG (Uganda) - Uganda National Interbank Settlement System, for cross-border payments.\n*`UPI`-India Unified Payments Interface.\n*`VCS`-VocaLink Clearing System\n*`XCT`-EBA step 2.\n*`ZEN`-JP (Japan) the Zengin system. The electronic payment system for domestic third party transfers managed by the Tokyo Bankers Association.\n*`ZET`-ZW (Zimbabwe) - Zimbabwe Electronic Transfer & Settlement System.\n*`ZIS`-ZM (Zambia) - Zambian Interbank Payment &Settlement System.\n*`ISG`-IS (Iceland) – Icelandic krona RTGS (MBK).\n*`NBO`-NO - Norway NOK RTGS Norges Bank\n*`ISW`-NG (Nigeria) - Interswitch.\n*`I27`-P27 Clearing – Instant Payment Platform.\n*`B27`-P27 Clearing – Batch Payment Platform.\n*`UKD`-UK (United Kingdom) – Pay.UK Sterling Domestic.\n*`RIX`-SE (Sweden) – SEK RTGS (RIX).\n*`MOC`-Banco de Mocambique RTGS system.\n*`BOK`-KR (South Korea) – Korean Won RTGS (BOK-Wire+).\n*`KTS`-PG (Papua New Guinea) – Kina Automated Transfer System RTGS (KATS RTGS).\n*`RON`-RO- Romania RON RTGS National Bank of Romania.\n*`TWP`-Taiwan Real-Time Gross Settlement System.\n*`SRB`-Narodowy Bank Polski RTGS System.\n*`RBM`-Malawi – Malawi Interbank Transfer and Settlement System.\n*`ISR`-IL- Bank of Israel RTGS System Code.\n*`NFT`-Provides information to the remitter when incoming cross border transactions are routed through NEFT in the Indian domestic leg.\n*`RGS`-Provides information to the remitter when incoming cross border transactions are routed through RTGS in the Indian domestic leg.\n*`LSW`-LS (Lesotho) - RTGS (Wire).\n*`REN`-MY (Malaysia) - RENTAS, Real Time Electronic Transfer of Funds and Securities in Ringgit denomination.\n*`IBG`-MY (Malaysia) - Interbank GIRO.\n*`SGA`-BEAC (Bank of the Central African States) RTGS (SYGMA)\n*`CIT`-Inter-Bank Payment System (IBPS), settlement of multi-currency, real-time and batch interbank payments in Vietnam.\n*`NAP`-Instant Payment System for payments in VN Dong denomination.\n*`RSD`-RS (Republic of Serbia) – Serbian RTGS in Serbian Dinars.\n*`RSE`-RS (Republic of Serbia) – Interbank and International Clearing of FX Payments in Euros.\n*`UGD`-UG (Uganda) – Uganda Domestic Automated Transfer System RTGS.\n*`CBH`-COMESA Clearing House Regional Payment and Settlement System, a regional cross-border payment and settlement platform designed to facilitate efficient and secure intra-regional trade payments within COMESA (Common Market for Eastern and Southern Africa) member states.\n*`CBP`-COMESA (Common Market for Eastern and Southern Africa) RTGS system.\n*`DZR`-Identification of the RTGS system of the Algeria."
      enum:
        - ABE
        - ACH
        - ACS
        - AIP
        - ART
        - AVP
        - AZM
        - BAP
        - BCC
        - BCE
        - BDS
        - BEL
        - BGN
        - BHS
        - BIS
        - BOF
        - BOJ
        - BRL
        - BSP
        - CAD
        - CAM
        - CBA
        - CBC
        - CBJ
        - CCE
        - CHI
        - CHP
        - CIP
        - CIS
        - COE
        - COI
        - COU
        - DDK
        - DKC
        - EBA
        - ELS
        - EMZ
        - EPM
        - EPN
        - ERP
        - FDA
        - FDN
        - FDW
        - FEY
        - FPS
        - GIS
        - HKL
        - HKS
        - HRK
        - HRM
        - HUF
        - IBP
        - INC
        - IMP
        - JOD
        - KPS
        - LGS
        - LKB
        - LVL
        - LVT
        - LYX
        - MEP
        - MOS
        - MQQ
        - MRS
        - MUP
        - NAM
        - NOC
        - NOR
        - NPP
        - NSS
        - NZE
        - PCH
        - PDS
        - PEG
        - PNS
        - PSA
        - PTR
        - PVE
        - ROL
        - ROS
        - RTG
        - RTP
        - RTR
        - SCL
        - SCP
        - SEC
        - SEU
        - SIC
        - SIP
        - SIT
        - SLB
        - SPG
        - SSK
        - ST2
        - STG
        - TBF
        - TCH
        - TGT
        - THB
        - THN
        - TIS
        - TOP
        - TTD
        - UBE
        - UIS
        - UPI
        - VCS
        - XCT
        - ZEN
        - ZET
        - ZIS
        - ISG
        - NBO
        - ISW
        - I27
        - B27
        - UKD
        - RIX
        - MOC
        - BOK
        - KTS
        - RON
        - TWP
        - SRB
        - RBM
        - ISR
        - NFT
        - RGS
        - LSW
        - REN
        - IBG
        - SGA
        - CIT
        - NAP
        - RSD
        - RSE
        - UGD
        - CBH
        - CBP
        - DZR
    ExternalCategoryPurpose1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the category purpose, as published in an external category purpose code list.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`BONU`-Transaction is the payment of a bonus.\n*`CASH`-Transaction is a general cash management instruction.\n*`CBLK`-A service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details.\n*`CCRD`-Transaction is related to a payment of credit card.\n*`CORT`-Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction.\n*`DCRD`-Transaction is related to a payment of debit card.\n*`DIVI`-Transaction is the payment of dividends.\n*`DVPM`-Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.\n*`EPAY`-Transaction is related to ePayment.\n*`FCIN`-Transaction is related to the payment of a fee and interest.\n*`FCOL`-A service that is settling card transaction related fees between two parties.\n*`GP2P`-General Person-to-Person Payment. Debtor and Creditor are natural persons.\n*`GOVT`-Transaction is a payment to or from a government department.\n*`HEDG`-Transaction is related to the payment of a hedging operation.\n*`ICCP`-Transaction is reimbursement of credit card payment.\n*`IDCP`-Transaction is reimbursement of debit card payment.\n*`INTC`-Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.\n*`INTE`-Transaction is the payment of interest.\n*`LBOX`-Transaction is related to identify cash handling via Night Safe or Lockbox by bank or vendor on behalf of a physical store.\n*`LOAN`-Transaction is related to the transfer of a loan to a borrower.\n*`MP2B`-Mobile P2B Payment\n*`MP2P`-Mobile P2P Payment\n*`OTHR`-Other payment purpose.\n*`PENS`-Transaction is the payment of pension.\n*`RPRE`-Collection used to re-present previously reversed or returned direct debit transactions.\n*`RRCT`-Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer.\n*`RVPM`-Code used to pre-advise the account servicer of a forthcoming receive against payment instruction.\n*`SALA`-Transaction is the payment of salaries.\n*`SECU`-Transaction is the payment of securities.\n*`SSBE`-Transaction is a social security benefit, ie payment made by a government to support individuals.\n*`SUPP`-Transaction is related to a payment to a supplier.\n*`TAXS`-Transaction is the payment of taxes.\n*`TRAD`-Transaction is related to the payment of a trade finance transaction.\n*`TREA`-Transaction is related to treasury operations.  E.g. financial contract settlement.\n*`VATX`-Transaction is the payment of value added tax.\n*`WHLD`-Transaction is the payment of withholding tax.\n*`SWEP`-Classification: Cash Management. Transaction relates to a cash management instruction, requesting a sweep of the account of the Debtor above an agreed floor amount, up to a target or zero balance.\r\nThe purpose is to move the funds from multiple accounts to a single bank account. Funds can move domestically or across border and more than one bank can be used.\n*`TOPG`-Classification: Cash Management. Transaction relates to a cash management instruction, requesting to top the account of the Creditor above a certain floor amount, up to a target or zero balance. \r\nThe floor amount, if not pre-agreed by the parties involved, may be specified.\n*`ZABA`-Transaction relates to a cash management instruction, requesting to zero balance the account of the Debtor.\r\nZero Balance Accounts empty or fill the balances in accounts at the same bank, in the same country into or out of a main account each day.\n*`VOST`-Transaction to be processed as a domestic payment instruction originated from a foreign bank.\n*`FCDT`-Foreign Currency Transaction that is processed between two domestic financial institutions.\n*`CIPC`-Transaction is a direct debit for a cash order of notes and/or coins.\n*`CONC`-Transaction is a direct debit for a cash order of notes and/or coins.\n*`CGWV`-Transaction is a payment towards a Party for the collection of cash by the Cash in Transit company.\n*`SAVG`-Transfer to / from savings or to retirement account.\n*`CTDF`-Cross border transaction initiated by US natural person that is subject to compliance with Dodd Frank 1073."
      enum:
        - BONU
        - CASH
        - CBLK
        - CCRD
        - CORT
        - DCRD
        - DIVI
        - DVPM
        - EPAY
        - FCIN
        - FCOL
        - GP2P
        - GOVT
        - HEDG
        - ICCP
        - IDCP
        - INTC
        - INTE
        - LBOX
        - LOAN
        - MP2B
        - MP2P
        - OTHR
        - PENS
        - RPRE
        - RRCT
        - RVPM
        - SALA
        - SECU
        - SSBE
        - SUPP
        - TAXS
        - TRAD
        - TREA
        - VATX
        - WHLD
        - SWEP
        - TOPG
        - ZABA
        - VOST
        - FCDT
        - CIPC
        - CONC
        - CGWV
        - SAVG
        - CTDF
    ExternalClearingSystemIdentification1Code:
      type: string
      minLength: 1
      maxLength: 5
      description: "Specifies the clearing system identification code, as published in an external clearing system identification code list.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`ATBLZ`-Bank Branch code used in Austria.\n*`AUBSB`-Bank Branch code used in Australia.\n*`CACPA`-Bank Branch code used in Canada.\n*`CHBCC`-Financial Institution Identification (IID) used in Switzerland, without check digit.\n*`CHSIC`-Financial Institution Identification (IID) used in Switzerland, including check digit.\n*`CNAPS`-Bank Branch code used in China.\n*`DEBLZ`-Bank Branch code used in Germany.\n*`ESNCC`-Bank Branch code used in Spain.\n*`GBDSC`-Bank Branch code used in the UK.\n*`GRBIC`-Bank Branch code used in Greece.\n*`HKNCC`-Bank Branch code used in Hong Kong.\n*`IENCC`-Bank Branch code used in Ireland.\n*`INFSC`-Bank Branch code used in India.\n*`ITNCC`-Bank Branch code used in Italy.\n*`JPZGN`-Bank Branch code used in Japan.\n*`NZNCC`-Bank Branch code used in New Zealand.\n*`PLKNR`-Bank Branch code used in Poland.\n*`PTNCC`-Bank Branch code used in Portugal.\n*`RUCBC`-Bank Branch code used in Russia.\n*`SESBA`-Bank Branch code used in Sweden.\n*`SGIBG`-Bank Branch code used in Singapore.\n*`THCBC`-Bank Identification code used in Thailand.\n*`TWNCC`-Bank Branch code used in Taiwan.\n*`USABA`-Routing Transit number assigned by the ABA for US financial institutions.\n*`USPID`-Bank identifier used by CHIPs in the US.\n*`ZANCC`-Bank Branch code used in South Africa.\n*`NZRSA`-RTGS settlement account used in New Zealand.\n*`MZBMO`-Banco de Mocambique RTGS system.\n*`CNCIP`-Chinese Cross-border Interbank Payment System (CIPS) Identifier.\n*`KRBOK`-Participant Institution code used by BOK-Wire+ in South Korea.\n*`BRISP`-Bank Identification code used in Brazil (ISPB).\n*`NACSC`-Clearing system Identification code used in Namibia.\n*`ZWTSS`-System Identification Code used in the Zimbabwe settlement system.\n*`AD`-Clearing System ID used in Andorra\n*`EGNCC`-RTGS Clearing system Identification code used in Egypt.\n*`AE`-Clearing System ID used in United Arab Emirates\n*`AF`-Clearing System ID used in Afghanistan\n*`AI`-Clearing System ID used in Antigua and Bermuda\n*`AL`-Clearing System ID used in Albania\n*`AM`-Clearing System ID used in Armenia\n*`AO`-Clearing System ID used in Angola\n*`AR`-Clearing System ID used in Argentina\n*`AS`-Clearing System ID used in American Samoa\n*`AW`-Clearing System ID used in Aruba \n*`AZ`-Clearing System ID used in Azerbaijan\n*`BA`-Clearing System ID used in Bosnia and Herzegovina\n*`BD`-Clearing System ID used in Bangladesh\n*`BG`-Clearing System ID used in Bulgaria\n*`BH`-Clearing System ID used in Bahrain\n*`BI`-Clearing System ID used in Burundi\n*`BL`-Clearing System ID used in Saint Barthelemy\n*`BM`-Clearing System ID used in Bermuda\n*`BN`-Clearing System ID used in Brunei Darussalam\n*`BO`-Clearing System ID used in Bolivia\n*`BS`-Clearing System ID used in Bahamas\n*`BT`-Clearing System ID used in Bhutan\n*`BW`-Clearing System ID used in Botswana\n*`BY`-Clearing System ID used in Belarus\n*`BZ`-Clearing System ID used in Belize\n*`CD`-Clearing System ID used in Democratic Republic of The Congo \n*`CL`-Clearing System ID used in Chile\n*`CO`-Clearing System ID used in Colombia\n*`CR`-Clearing System ID used in Costa Rica\n*`CV`-Clearing System ID used in Cabo Verde\n*`CW`-Clearing System ID used in Curacao\n*`CY`-Clearing System ID used in Cyprus\n*`CZ`-Clearing System ID used in Czech Republic\n*`DO`-Clearing System ID used in Dominican Republic\n*`DZ`-Clearing System ID used in Algeria\n*`EC`-Clearing System ID used in Ecuador\n*`EE`-Clearing System ID used in Estonia\n*`GE`-Clearing System ID used in Georgia\n*`GH`-Clearing System ID used in Ghana\n*`GN`-Clearing System ID used in Guinea\n*`GT`-Clearing System ID used in Guatemala\n*`GY`-Clearing System ID used in Guyana\n*`HN`-Clearing System ID used in Honduras\n*`HR`-Clearing System ID used in Croatia\n*`HT`-Clearing System ID used in Haiti\n*`HU`-Clearing System ID used in Hungary\n*`ID`-Clearing System ID used in Indonesia\n*`IL`-Clearing System ID used in Israel\n*`IQ`-Clearing System ID used in Iraq\n*`IS`-Clearing System ID used in Iceland\n*`JM`-Clearing System ID used in Jamaica\n*`JO`-Clearing System ID used in Jordan\n*`KE`-Clearing System ID used in Kenya\n*`KG`-Clearing System ID used in The Kyrgyz Republic\n*`KH`-Clearing System ID used in Cambodia\n*`KM`-Clearing System ID used in Comoros\n*`KW`-Clearing System ID used in Kuwait\n*`KZ`-Clearing System ID used in Kazakhstan\n*`LB`-Clearing System ID used in Lebanon\n*`LK`-Clearing System ID used in Sri Lanka\n*`LR`-Clearing System ID used in Liberia\n*`LS`-Clearing System ID used in Lesotho\n*`LT`-Clearing System ID used in Lithuania \n*`LV`-Clearing System ID used in Latvia\n*`LY`-Clearing System ID used in Libya\n*`MD`-Clearing System ID used in Moldova\n*`ME`-Clearing System ID used in Montenegro\n*`MG`-Clearing System ID used in Madagascar\n*`MK`-Clearing System ID used in North Macedonia\n*`MN`-Clearing System ID used in Mongolia\n*`MO`-Clearing System ID used in Macao\n*`MR`-Clearing System ID used in Mauritania\n*`MT`-Clearing System ID used in Malta\n*`MU`-Clearing System ID used in Mauritius\n*`MW`-Clearing System ID used in Malawi \n*`MX`-Clearing System ID used in Mexico\n*`MY`-Clearing System ID used in Malaysia\n*`NG`-Clearing System ID used in Nigeria\n*`NI`-Clearing System ID used in Nicaragua\n*`NP`-Clearing System ID used in Nepal\n*`OM`-Clearing System ID used in Oman\n*`PA`-Clearing System ID used in Panama\n*`PE`-Clearing System ID used in Peru\n*`PG`-Clearing System ID used in Papua New Guinea\n*`PH`-Clearing System ID used in Philippines \n*`PK`-Clearing System ID used in Pakistan\n*`PS`-Clearing System ID used in Palestine\n*`PY`-Clearing System ID used in Paraguay \n*`QA`-Clearing System ID used in Qatar\n*`RO`-Clearing System ID used in Romania\n*`RS`-Clearing System ID used in Serbia\n*`RW`-Clearing System ID used in Rwanda\n*`SA`-Clearing System ID used in Saudi Arabia\n*`SC`-Clearing System ID used in Seychelles\n*`SD`-Clearing System ID used in Sudan\n*`SI`-Clearing System ID used in Slovenia\n*`SK`-Clearing System ID used in Slovakia \n*`SL`-Clearing System ID used in Sierra Leone\n*`ST`-Clearing System ID used in Sao Tome and Principe\n*`SV`-Clearing System ID used in El Salvador\n*`SZ`-Clearing System ID used in Eswatini \n*`TJ`-Clearing System ID used in Tajikistan\n*`TL`-Clearing System ID used in Timor-Leste\n*`TM`-Clearing System ID used in Turkmenistan\n*`TN`-Clearing System ID used in Tunisia\n*`TR`-Clearing System ID used in Turkey\n*`TT`-Clearing System ID used in Trinidad and Tobago\n*`TZ`-Clearing System ID used in Tanzania\n*`UA`-Clearing System ID used in Ukraine\n*`UG`-Clearing System ID used in Uganda\n*`UY`-Clearing System ID used in Uruguay\n*`UZ`-Clearing System ID used in Uzbekistan\n*`VA`-Clearing System ID used in Vatican City\n*`VE`-Clearing System ID used in Venezuela\n*`VN`-Clearing System ID used in Vietnam\n*`XK`-Clearing System ID used in Kosovo\n*`ZM`-Clearing System ID used in Zambia\n*`MARPA`-RTGS participant identification code used in the Kingdom of Morocco.\n*`MARAC`-RTGS clearing system identification used in the Kingdom of Morocco.\n*`CEAPA`-Bank Of Central African States (BEAC) Participant Identification Code – Financial Institution Identification used in BEAC’s SYGMA system for settlement between participants in Cameroon, Central Africa Republic, Chad, Equatorial Guinea, Gabon and Republic of the Congo. In this case, it is particular to the form of electronic payment of Real Time Gross Settlement.\n*`CEAAC`-Bank Of Central African States (BEAC) Participant Account Identification Code – Financial Institution Identification used in BEAC’s SYGMA system for settlement between participants accounts in Cameroon, Central Africa Republic, Chad, Equatorial Guinea, Gabon and Republic of the Congo. In this case, it is particular to the form of electronic payment of Real Time Gross Settlement.\n*`RSDPA`-RTGS participant identification code used in the Republic of Serbia.\n*`RSDAC`-RTGS account identification code used in the Republic of Serbia.\n*`RSEPA`-Interbank and International Clearing of FX Payments System participant identification code used in the Republic of Serbia.\n*`RSEAC`-Interbank and International Clearing of FX Payments account identification code used in the Republic of Serbia.\n*`MUPPA`-MACSS participant identification code used in Mauritus.\n*`MUPAC`-MACSS settlement account used in Mauritius.\n*`CBHPA`-REPSS (Regional cross-border payment and settlement platform designed to facilitate efficient and secure intra-regional trade payments within COMESA member states) participant identification code.\n*`CBHAC`-REPSS (regional cross-border payment and settlement platform designed to facilitate efficient and secure intra-regional trade payments within COMESA member states) settlement account.\n*`CBPPA`-COMESA SS participant identification code.\n*`CBPAC`-COMESA SS settlement account. \n*`DZRPA`-Agent identification code used in the RTGS system of Algeria.\n*`DZRAC`-Account identification code used in the RTGS system of Algeria."
      enum:
        - ATBLZ
        - AUBSB
        - CACPA
        - CHBCC
        - CHSIC
        - CNAPS
        - DEBLZ
        - ESNCC
        - GBDSC
        - GRBIC
        - HKNCC
        - IENCC
        - INFSC
        - ITNCC
        - JPZGN
        - NZNCC
        - PLKNR
        - PTNCC
        - RUCBC
        - SESBA
        - SGIBG
        - THCBC
        - TWNCC
        - USABA
        - USPID
        - ZANCC
        - NZRSA
        - MZBMO
        - CNCIP
        - KRBOK
        - BRISP
        - NACSC
        - ZWTSS
        - AD
        - EGNCC
        - AE
        - AF
        - AI
        - AL
        - AM
        - AO
        - AR
        - AS
        - AW
        - AZ
        - BA
        - BD
        - BG
        - BH
        - BI
        - BL
        - BM
        - BN
        - BO
        - BS
        - BT
        - BW
        - BY
        - BZ
        - CD
        - CL
        - CO
        - CR
        - CV
        - CW
        - CY
        - CZ
        - DO
        - DZ
        - EC
        - EE
        - GE
        - GH
        - GN
        - GT
        - GY
        - HN
        - HR
        - HT
        - HU
        - ID
        - IL
        - IQ
        - IS
        - JM
        - JO
        - KE
        - KG
        - KH
        - KM
        - KW
        - KZ
        - LB
        - LK
        - LR
        - LS
        - LT
        - LV
        - LY
        - MD
        - ME
        - MG
        - MK
        - MN
        - MO
        - MR
        - MT
        - MU
        - MW
        - MX
        - MY
        - NG
        - NI
        - NP
        - OM
        - PA
        - PE
        - PG
        - PH
        - PK
        - PS
        - PY
        - QA
        - RO
        - RS
        - RW
        - SA
        - SC
        - SD
        - SI
        - SK
        - SL
        - ST
        - SV
        - SZ
        - TJ
        - TL
        - TM
        - TN
        - TR
        - TT
        - TZ
        - UA
        - UG
        - UY
        - UZ
        - VA
        - VE
        - VN
        - XK
        - ZM
        - MARPA
        - MARAC
        - CEAPA
        - CEAAC
        - RSDPA
        - RSDAC
        - RSEPA
        - RSEAC
        - MUPPA
        - MUPAC
        - CBHPA
        - CBHAC
        - CBPPA
        - CBPAC
        - DZRPA
        - DZRAC
    ExternalDiscountAmountType1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the nature, or use, of the amount in the format of character string with a maximum length of 4 characters.\r\nThe list of valid codes is an external code list published separately.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`APDS`-Addition discount based on third-party agreed business promotional activity, i.e., extra 10 percent discount for 15 days)\n*`STDS`-Discount based on volume purchased.\n*`TMDS`-Discount based on terms negotiated for payment within a specified time period, i.e., 2/10 Net 30 (2 percent discount if paid in 10 days; otherwise, net amount is due in 30 days)."
      enum:
        - APDS
        - STDS
        - TMDS
    ExternalDocumentLineType1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: >-
        Specifies the document line type as published in an external document
        type code list.

        *`ADPI`-Line item reference is an additional product identification
        assigned by the manufacturer.

        *`AISB`-Line item reference is an alternate International Standard Book
        Number (ISBN).

        *`ASNB`-Line item reference is an asset number.

        *`CTNB`-Line item reference is a catalog number.

        *`DBSP`-Line item reference is Dun & Bradstreet Standard Product and
        Service code.

        *`EANN`-Line item reference is an European Article Number (EAN).

        *`EINB`-Line item reference is an equipment identification number.

        *`GSNB`-Line item reference is a general specification number.

        *`HIBC`-Line item reference is a Health Care Industry Bar Code (HIBC)

        *`ISBN`-Line item reference is an International Standard Book Number
        (ISBN).

        *`LTNB`-Line item reference is a lot number.

        *`MDNB`-Line item reference is a model number

        *`PRNB`-Line item reference is a part reference number.

        *`PTCD`-Line item reference is a product type code.

        *`SKNB`-Line item reference is a stock number.

        *`STNB`-Line item reference is a style number.

        *`TONB`-Line item reference is a technical order number.

        *`UPCC`-Line item reference is an UPC consumer package code.

        *`UPNB`-Line item reference is an Universal Product Number.
      enum:
        - ADPI
        - AISB
        - ASNB
        - CTNB
        - DBSP
        - EANN
        - EINB
        - GSNB
        - HIBC
        - ISBN
        - LTNB
        - MDNB
        - PRNB
        - PTCD
        - SKNB
        - STNB
        - TONB
        - UPCC
        - UPNB
    ExternalFinancialInstitutionIdentification1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters.\r\nThe list of valid codes is an external code list published separately.\r\nExternal code sets can be downloaded from www.iso20022.org."
    ExternalGarnishmentType1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: >-
        Specifies the garnishment type as published in an external document type
        code list.

        *`GNCS`-Garnishment from a third party payer for Child Support

        *`GNDP`-Garnishment from a direct payer for Child Support

        *`GTPP`-Garnishment from a third party payer to taxing agency
      enum:
        - GNCS
        - GNDP
        - GTPP
    ExternalLocalInstrument1Code:
      type: string
      minLength: 1
      maxLength: 35
      description: "Specifies the external local instrument code in the format of character string with a maximum length of 35 characters.\r\nThe list of valid codes is an external code list published separately.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`DDMC`-Transaction is related to a direct debit instruction authorized under a confirmed electronic mandate.\n*`DDMP`-Transaction is related to a direct debit instruction authorized under a paper based mandate, supported by paper authorization signed by the debtor.\n*`DDMU`-Transaction is related to a direct debit instruction authorized under an unconfirmed electronic mandate requiring confirmation by the debtor.\n*`BPA`-Transaction is related to an Instant Credit Transfer under the rules of the Centrale Bank van Aruba, based on the EPC SCT Inst scheme, with a specific batch time-out delay.\n*`IPA`-Transaction is related to an Instant Credit Transfer under the rules of the Centrale Bank van Aruba, based on the EPC SCT Inst scheme.\n*`TRF`-Transaction is related to credit transfers\n*`82`-Transaction is related to a direct debit that is not pre authorised (Einzugsermächtigung). \n*`83`-Transaction is related to a direct debit that is pre authorised (Abbuchungsauftrag). \n*`CPP`-Transaction is related to cash per post.\nTransaction to ultimate recipient having no bank account. Primary beneficiary is a postal service provider. Funds are paid out by cash. Additional necessary information for address and delivery options need to be attached.\n\n*`RTR`-Transaction is related to returned credit transfers.\n*`GST`-Transaction is related to truncated credit transfers.\nConversion of physical instrument to electonric form for transmission to the paying bank and where the original paper document does not continue in the clearing process..The original instrument rules are retained throughout the life of the instrument.\nTransaction triggered by specific marked and populated paper slip.\nReconciliation reference is secured by check digits supporting secure optical recognition. All other remittance information is truncated prior transmission.\n\n*`DDT`-Transaction is related to direct debits.\n*`RDD`-Transaction is related to returned direct debits.\n*`CHN`-Transaction is related to truncated checks.\nConversion of physical instrument to electonric form for transmission to the paying bank and where the original paper document does not continue in the clearing process..The original instrument rules are retained throughout the life of the instrument.\n*`STR`-Transaction is related to revoked credit transfers\n*`SDD`-Transaction is related to revoked direct debits.\n*`SRT`-Transaction is related to revoked returned credit transfers\n*`SRD`-Transaction is related to revoked returned direct debits.\n*`SCN`-Transaction is related to revoked truncated checks.\n*`SGT`-Transaction is related to revoked truncated credit transfers.\n*`CARD`-Transaction is related to card clearing.\n*`05`-Transaction is related to a direct debit that is not pre authorised (Einzugsermächtigung). \n*`04`-Transaction is related to a direct debit that is pre authorised (Abbuchungsauftrag). \n*`ISE`-Transaction is related to the German Image-based Cheque Collection Procedure “Imagegestützter Scheckeinzug - ISE”\n*`BSE`-Transaction is related to the German Paperless Cheque Collection procedure “Belegloser Scheckeinzug - BSE”\n*`58`-Transaction is related to a business-to-business direct debit (CSB58).\n*`19`-Transaction is related to a business-to-customer direct debit (CSB19).\n*`ASTI`-Indicates that the payment is sent by an authorized third party on behalf of the participant. \n*`BACP`-Indicates that the payment was initiated manually using a GUI (Graphical User Interface).\n*`MANP`-Indicates that the payment is sent by responsible Central Bank on behalf of the participant in case of contingency.\n*`SBTI`-Indicates that the payment is submitted to move  liquidity to the technical account - dedicated to real-time settlement in an external system (for example ancillary system) . The payment is processed in a separate payment queue besides the normal processing.\n*`85`-Transaction is related to an urgent direct debit that is pre authorised (Avis de Prélèvement accéléré).\n*`08`-Transaction is related to a direct debit that is pre authorised (Avis de Prélèvement).\n*`89`-Transaction is related to an urgent direct debit that is pre authorised (Avis de Prélèvement vérifié).\n*`60`-LCR - Lettre de Change Relevé (Recovered Bill of Exchange) and BOR - Billet à Orde Relevé (Promissory Note)\n*`RIBA`-Transaction is related to a non-pre authorised collection (RIBA).\n*`RIDO`-Transaction is related to a direct debit that is pre authorised and revocable (RID Ordinario).\n*`RIDV`-Transaction is related to an urgent direct debit that is pre authorised and revocable (RID Veloce).\n*`IDEAL`-Transaction is related to payments via internet owned by Currence.\n*`INSTNT01`-The transaction is related to a regular  Credit Transfer and will be instantly processed under the Dutch AOS on top of the EPC SCT scheme.\n*`INSTTC01`-The transaction is related to an Instant Credit Transfer under the rules of the Dutch AOS on top of the EPC SCT Inst scheme.\n*`INSTIDEAL`-Transaction is related to payments via internet owned by Currence which uses an Instant Credit Transfer.\n*`INSTNT01IDEAL`-Transaction is related to payments via internet owned by Currence which uses a regular  Credit Transfer and will be instantly processed under the Dutch AOS on top of the EPC SCT scheme.\n*`INSTTC01IDEAL`-Transaction is related to payments via internet owned by Currence which uses an Instant Credit Transfer under the rules of the Dutch AOS on top of the EPC SCT Inst scheme.\n*`NLDO`-Transaction is related to a Domestic payment initiated by PAIN.001\n*`NLUP`-Transaction is related to a Domestic payment initiated by PAIN.001\n*`SDN`-Transaction is related to payments via a ‘Standaard Digitale Nota’ InvoiceAcceptgiro payment.\n*`ACCEPT`-Transaction is related to payments via Acceptgiro owned by Currence.\n*`ICMC`-Transaction is related to an Incident Management Correction procedure based on the DD infrastructure.\n*`NLGOV`-Transaction is related to direct debit scheme owned by the NVB.\n*`IN`-Transaction is related to cross border customer credit transfer.\n*`ONCL`-Transaction is related to overnight clearing.\n*`PERI`-Credit transfer contains Extended Remittance Information (ERI) as defined within the applicable scheme.\n*`SDCL`-Transaction is related to New Zealand High Value Clearing System (HVCS) same day clearing payments.\n*`DDNR`-SEPA Core Direct Debit with ‘no refund’ option\n*`DDFA`-SEPA Fixed Amount Direct Debit\n*`CORE`-Transaction is related to SEPA direct debit -core.\n*`B2BAMIPM`-SEPA B2B Direct Debit AMI based on a paper mandate\n*`B2B`-Transaction is related to SEPA business to business direct debit.\n*`CR1AMIPM`-Optional shorter time cycle (D-1) for SEPA Core Direct Debit AMI based on a paper mandate\n*`CORAMIPM`-SEPA Core Direct Debit AMI based on a paper mandate\n*`COR1`-Optional shorter time cycle (D-1) for SEPA Core Direct Debit\n*`FADAMIPM`-SEPA Fixed Amount Direct Debit AMI based on a paper mandate\n*`CLSCCPERX`-Transaction is related to the CLSClearedFX service for Eurex.  \nUsage: The code is mandatory for all pacs.009 payments to this service.\n*`CLSCCPLCH`-Transaction is related to the CLSClearedFX service for London Exchange Clearing House. \nUsage: The code is mandatory for all pacs.009 payments to this service.\n*`INST`-Transaction is related to an Instant Credit Transfer.\nUse case example: SEPA Instant Credit Transfer (SCT Inst)\n*`ADD`-Transaction is authenticated direct debit for domestic use.\n*`UDD`-Transaction is unauthenticated direct debit for domestic use.\n*`CCI`-Transaction is related to an intra-group bank initiated cash management payment\n*`IAT`-Transaction is related to international ACH.\n*`CCD`-Transaction is related to cash concentration or disbursement corporate counterparty.\n*`CTX`-Transaction is related to corporate trade exchange.\n*`PPD`-Transaction is related to prearranged payment or deposit consumer counterparty.\n*`CIE`-A credit entry initiated by or on behalf of the holder of a consumer account\n*`RCK`-Transaction is related to re-presented check entry.\n*`ARC`-Transaction is related to accounts receivable check.\n*`WEB`-Transaction is related to internet initiated entry.\n*`POP`-Transaction is related to point-of-purchase.\n*`POS`-Transaction is related to point-of-sale.\n*`TEL`-Transaction is related to telephone initiated entry.\n*`ITP`-Payment via Instant Credit Transfer but Credit Transfer is also possible.\n*`CTP`-Payment via Credit Transfer but Instant Credit Transfer is also possible.\n*`MDP`-Type of New Payments Architecture (NPA) payment. Payments are processed over a three-day cycle and available to customers early in the morning of Day 3.\n*`IMD`-Type of Payment used within the New Payments Architecture (UK). Immediate Payments are used for payments initiated by customers using channels such as internet, mobile or telephone banking, where the customer wants the payment to be effected immediately.\n*`SOP`-Standing Orders are regular payments of a fixed amount paid to the same recipient on a specified date, for example, to pay rent.\n*`FDP`-Type of Payment used within the New Payments Architecture (UK). Forward-dated payments are one-off payments sent and received on a pre-arranged date, set-up by the customer in advance, for example, to pay a bill."
      enum:
        - DDMC
        - DDMP
        - DDMU
        - BPA
        - IPA
        - TRF
        - '82'
        - '83'
        - CPP
        - RTR
        - GST
        - DDT
        - RDD
        - CHN
        - STR
        - SDD
        - SRT
        - SRD
        - SCN
        - SGT
        - CARD
        - '05'
        - '04'
        - ISE
        - BSE
        - '58'
        - '19'
        - ASTI
        - BACP
        - MANP
        - SBTI
        - '85'
        - '08'
        - '89'
        - '60'
        - RIBA
        - RIDO
        - RIDV
        - IDEAL
        - INSTNT01
        - INSTTC01
        - INSTIDEAL
        - INSTNT01IDEAL
        - INSTTC01IDEAL
        - NLDO
        - NLUP
        - SDN
        - ACCEPT
        - ICMC
        - NLGOV
        - IN
        - ONCL
        - PERI
        - SDCL
        - DDNR
        - DDFA
        - CORE
        - B2BAMIPM
        - B2B
        - CR1AMIPM
        - CORAMIPM
        - COR1
        - FADAMIPM
        - CLSCCPERX
        - CLSCCPLCH
        - INST
        - ADD
        - UDD
        - CCI
        - IAT
        - CCD
        - CTX
        - PPD
        - CIE
        - RCK
        - ARC
        - WEB
        - POP
        - POS
        - TEL
        - ITP
        - CTP
        - MDP
        - IMD
        - SOP
        - FDP
    ExternalMandateSetupReason1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the external mandate setup reason code in the format of character string with a maximum length of 4 characters.\r\nExternal code sets can be downloaded from www.iso20022.org."
    ExternalOrganisationIdentification1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters.\r\nThe list of valid codes is an external code list published separately.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`BANK`-Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. \n*`CBID`-A unique identification number assigned by a central bank to identify an organisation.\n*`CHID`-A unique identification number assigned by a clearing house to identify an organisation\n*`CINC`-A unique identification number assigned by a designated authority to a certificate of incorporation and used to identify an organisation.\n*`COID`-Country authority given organisation identification (e.g., corporate registration number)\n*`CUST`-Number assigned by an issuer to identify a customer.\nNumber assigned by a party to identify a creditor or debtor relationship.\n*`DUNS`-A unique identification number provided by Dun & Bradstreet to identify an organisation.\n*`EMPL`-Number assigned by a registration authority to an employer.\n*`GS1G`-Global Location Number. A non-significant reference number used to identify legal entities, functional entities, or physical entities according to GS1 numbering scheme rules.The number is used to retrieve detailed information that is linked to it.\n*`SREN`-The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.\n*`SRET`-The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity\n*`TXID`-Number assigned by a tax authority to identify an organisation.\n*`BDID`-Identifier of the business domain in which the organisation is active.\n*`BOID`-Other identification of the organisation."
      enum:
        - BANK
        - CBID
        - CHID
        - CINC
        - COID
        - CUST
        - DUNS
        - EMPL
        - GS1G
        - SREN
        - SRET
        - TXID
        - BDID
        - BOID
    ExternalPaymentGroupStatus1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the status of a group of payment instructions, as published in an external payment group status code set.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`ACCP`-Preceding check of technical validation was successful. Customer profile check was also successful.\n*`ACCC`-Settlement on the creditor's account has been completed.\n*`ACSC`-Settlement on the debtor's account has been completed.\nUsage : this can be used by the first agent to report to the debtor that the transaction has been completed. \nWarning : this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement\n\n*`ACSP`-All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.\n*`ACTC`-Authentication and syntactical and semantical validation are successful\n*`ACWC`-Instruction is accepted but a change will be made, such as date or remittance not sent.\n*`PART`-A number of transactions have been accepted, whereas another number of transactions have not yet achieved\n'accepted' status.\n*`PDNG`-Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.\n*`RCVD`-Payment initiation has been received by the receiving agent\n*`RJCT`-Payment initiation or individual transaction included in the payment initiation has been rejected.\n*`RCVC`-Verification of Payee check have been applied to received transactions stating to be complete without mismatching data.\n*`RVCM`-Verification of Payee checks have been applied to received transactions stating to be complete containing mismatching data.\n*`RVNC`-Verification of party check on transactions received is not yet completed."
      enum:
        - ACCP
        - ACCC
        - ACSC
        - ACSP
        - ACTC
        - ACWC
        - PART
        - PDNG
        - RCVD
        - RJCT
        - RCVC
        - RVCM
        - RVNC
    ExternalPaymentTransactionStatus1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the status of an individual payment instructions, as published in an external payment transaction status code set.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`ACCC`-Settlement on the creditor's account has been completed.\n*`ACCP`-Preceding check of technical validation was successful. Customer profile check was also successful.\n*`ACFC`-Preceding check of technical validation and customer profile was successful and an automatic funds check was positive.\n*`ACIS`-Payment instruction to issue a cheque has been accepted, and the cheque has been issued but not yet been deposited or cleared.\n*`ACSC`-Settlement completed.\nUsage : this can be used by a Market Infrastructure reporting to Infrastructure Participant or an Account Servicer to Account Owner to report that the transaction account entry has been completed.\nWarning : this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement\n\n*`ACSP`-All preceding checks such as technical validation and customer profile were successful and therefore the payment instruction has been accepted for execution.\n*`ACTC`-Authentication and syntactical and semantical validation are successful\n*`ACWC`-Instruction is accepted but a change will be made, such as date or remittance not sent.\n*`ACWP`-Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account.\n*`BLCK`-Payment transaction previously reported with status 'ACWP' is blocked, for example, funds will neither be posted to the Creditor's account, nor be returned to the Debtor.\n*`CANC`-Payment initiation has been successfully cancelled after having received a request for cancellation.\nUsage: code to be used in the context of APIs only.\n*`CPUC`-Cash has been picked up by the Creditor.\n*`PATC`-Payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful.\n*`PDNG`-Payment instruction is pending. Further checks and status update will be performed.\n*`PRES`-Request for Payment has been presented to the Debtor.\n*`RCVD`-Payment instruction has been received.\n*`RJCT`-Payment instruction has been rejected.\n*`ACPD`-Status of transaction released from the Debtor Agent and accepted by the clearing.\n*`RCVC`-Verification of Payee check has been applied to received transaction stating to be complete without mismatching data.\n*`RVNA`-Verification of Payee check has been applied to received transaction stating to be complete with not applicable data.\n*`RVNM`-Verification of Payee check has been applied to received transaction stating to be complete with mismatching data.\n*`RVMC`-Verification of Payee check has been applied to received transaction stating to be complete with data matching closely.\n*`ACFW`-Preceding check of technical validation and customer profile was successful, and an automatic funds check was positive, but an explicit confirmation by the initiating party is outstanding.\n*`RVNC`-Verification of party check on the transaction is not yet completed.\n*`RVCM`-Verification of Payee checks have been applied to received transaction stating to be completed containing mismatching data."
      enum:
        - ACCC
        - ACCP
        - ACFC
        - ACIS
        - ACSC
        - ACSP
        - ACTC
        - ACWC
        - ACWP
        - BLCK
        - CANC
        - CPUC
        - PATC
        - PDNG
        - PRES
        - RCVD
        - RJCT
        - ACPD
        - RCVC
        - RVNA
        - RVNM
        - RVMC
        - ACFW
        - RVNC
        - RVCM
    ExternalPersonIdentification1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters.\r\nThe list of valid codes is an external code list published separately.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`ARNU`-Number assigned by a social security agency to identify a non-resident person.\n*`CCPT`-Number assigned by an authority to identify the passport number of a person.\n*`CUST`-Number assigned by an issuer to identify a customer.\n*`DRLC`-Number assigned by an authority to identify a driver's license.\n*`EMPL`-Number assigned by a registration authority to an employee.\n*`NIDN`-Number assigned by an authority to identify the national identity number of a person.\n*`SOSE`-Number assigned by an authority to identify the social security number of a person.\n*`TELE`-Number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.\n*`TXID`-Number assigned by a tax authority to identify a person.\n*`POID`-Commercial identification of the person.\n*`BANK`-Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client."
      enum:
        - ARNU
        - CCPT
        - CUST
        - DRLC
        - EMPL
        - NIDN
        - SOSE
        - TELE
        - TXID
        - POID
        - BANK
    ExternalProxyAccountType1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the external proxy account type code, as published in the proxy account type external code set.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`TELE`-A telephone number in the format specified by the 'The international public telecommunication numbering plan ITU-T E.164. \n*`EMAL`-Internationalised address of an electronic mail box for internet messages.\n*`DNAM`-Internationalised internet domain name.\n*`CINC`-Corporate Identification issued by a national  institution or regulator, used as account proxy. \n(applied for corporate account proxy).\n*`COTX`-Unique government-issued tax Identification used as account proxy to identify the corporate (for example for government tax) and typically linked to the corporate bank account (applied for corporate account proxy).\n*`COID`-Identification issued by a national  institution or regulator (different from a national scheme like a clearing provider), used as account proxy (applied for corporate or individual account proxy).\n*`CUST`-Any other customer identification number issued by a corporate, bank or other organization, used as account proxy.\n(applied for corporate or individual account proxy).\n*`DRLC`-Unique government-issued Identification used as account proxy to  identify the individual  (for example for government charges, road taxes and tolls,vaccination charges) and typically linked to the individual's bank account (applied for  individual account proxy).\n*`EIDN`-Government-issued Identification (different from a passport Identification or a national Identification). Used as account proxy to  identify the individual (for example for public benefits) and typically linked to the individual's bank account (applied for  individual account proxy).\n*`EWAL`-Market-adopted prepaid instruments like e-Wallets, payments to / from e-wallets from / to bank accounts (applied for corporate or individual account proxy).\n*`PVTX`-Unique government-issued  tax Identification  used as account proxy to  identify the individual  for example for government tax) and typically linked to the individual's bank account (applied for  individual account proxy).\n*`LEIC`-Legal Entity Identifier used as account proxy (applied for corporate account proxy).\nUse cases: Can be used by corporates as a \"government-issued\" Identification for registration with payment schemes as a proxy. The proxy may be further used for payments and collections using the underlying instant payment rails for a variety of corporate use cases.\n*`MBNO`-Mobile phone number in the format specified by the “The international public telecommunication numbering plan ITU- T E 164\" (applied for corporate or individual account proxy).\n*`NIDN`-Unique government-issued Identification  used as account proxy to  identify the individual  or corporate for example for public benefits, government subsidies) and typically linked to the individual's / corporate bank account.\n(applied for corporate or individual account proxy).\n*`CCPT`-Unique government-issued Identification  used as account proxy to  identify the individual  (for example for government charges, road taxes, vaccination charges) and typically linked to the individual's bank account\n(applied for  individual account proxy).\n*`SHID`-Account proxy issued by a payment scheme (applied for corporate or individual account proxy).\nUse cases: Any proxies issued by clearing systems, for example VPA (India), FPS Identifier (Hong Kong), Jompay (Malaysia) CCIN (Canada).\n*`SOSE`-Unique government-issued Identification  used as account proxy to identify the individual  (for example for public benefits) and typically linked to the individual's bank account (applied for individual account proxy).\n*`TOKN`-Electronic Identification used, for example, to mask an account number as a means of data secrecy.\n(applied for corporate or individual account proxy).\n*`UBIL`-Subscriber Identification for utilities and services. As opposed to a biller Identification, this identification is used for the subscriber of the service (applied for corporate or individual account proxy).\n*`VIPN`-Account proxy for receiving insurance claims, pay insurance premium, road tax payments, traffic tickets etc.(applied for corporate or individual account proxy).\n*`BIID`-Billers of specific utilities could register for a Biller Identification as supported in the clearing scheme, and use this identification for collections (applied for corporate account proxy)."
      enum:
        - TELE
        - EMAL
        - DNAM
        - CINC
        - COTX
        - COID
        - CUST
        - DRLC
        - EIDN
        - EWAL
        - PVTX
        - LEIC
        - MBNO
        - NIDN
        - CCPT
        - SHID
        - SOSE
        - TOKN
        - UBIL
        - VIPN
        - BIID
    ExternalPurpose1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\r\nThe list of valid codes is an external code list published separately.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`BKDF`-Delayed draw funding. Certain issuers may utilize delayed draw loans whereby the lender is committed to fund cash within a specified period once a call is made by the issuer. The lender receives a fee for entering into such a commitment.\n*`BKFE`-Bank loan fees. Cash activity related to specific bank loan fees, including (a) agent / assignment fees; (b) amendment fees; (c) commitment fees; (d) consent fees; (e) cost of carry fees; (f) delayed compensation fees; (g) facility fees; (h) fronting fees; (i) funding fees; (j) letter of credit assignment fees.\n*`BKFM`-Bank loan funding memo. Net cash movement for the loan contract final notification when sent separately from the loan contract final notification instruction.\n*`BKIP`-Accrued interest payments. Specific to bank loans.\n*`BKPP`-Principal paydowns. Specific to bank loans\n*`CBLK`-A Service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details.\n*`CDCB`-Purchase of Goods and Services with additional Cash disbursement at the POI (Cashback).\n*`CDCD`-ATM Cash Withdrawal in an unattended or Cash Advance in an attended environment (POI or bank counter).\n*`CDCS`-ATM Cash Withdrawal in an unattended or Cash Advance in an attended environment (POI or bank counter) with surcharging.\n*`CDDP`-A combined service which enables the card acceptor to perform an authorisation for a temporary amount and a completion for the final amount within a limited time frame. Deferred Payment is only available in the unattended environment. Examples where this service is widely used are unattended petrol pumps and phone booths.\n*`CDOC`-A service which allows the card acceptor to effect a credit to a cardholder' account. Unlike a Merchant Refund, an Original Credit is not preceded by a card payment. This service is used for example for crediting winnings from gaming.\n*`CDQC`-Purchase of Goods which are equivalent to cash like coupons in casinos.\n*`ETUP`-Transaction is related to a Service that is first reserving money from a card account and then is loading an e-purse application by this amount.\n*`FCOL`-A Service that is settling card transaction related fees between two parties.\n*`MTUP`-A Service that is first reserving money from a card account and then is loading a prepaid mobile phone amount by this amount.\n*`ACCT`-Transaction moves funds between 2 accounts of same account holder at the same bank.\n*`CASH`-Transaction is a general cash management instruction.\n*`COLL`-Transaction is a collection of funds initiated via a credit transfer or direct debit.\n*`CSDB`-Transaction is related to cash disbursement.\n*`DEPT`-Transaction is releted to a payment of deposit.\n*`INTC`-Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.\n*`INTP`-Transaction is a payment between two accounts belonging to the same party (intra-party payment), where party is a natural person (identified by a private ID, not organisation ID).\n*`LIMA`-Bank initiated account transfer to support zero target balance management, pooling or sweeping.\n*`NETT`-Transaction is related to a netting operation.\n*`BFWD`-Cash collateral related to any securities traded out beyond 3 days which include treasury notes, JGBs and Gilts.\n*`CCIR`-Cash Collateral related to a Cross Currency Interest Rate Swap, indicating the exchange of fixed interest payments in one currency for those in another.\n*`CCPC`-Cash Collateral associated with an ISDA or Central Clearing Agreement that is covering the initial margin requirements for OTC trades clearing through a CCP. \n*`CCPM`-Cash Collateral associated with an ISDA or Central Clearing Agreement that is covering the variation margin requirements for OTC trades clearing through a CCP. \n*`CCSM`-CCP Segregated initial margin: Initial margin on OTC Derivatives cleared through a CCP that requires segregation.\n*`CRDS`-Cash collateral related to trading of credit default swap.\n*`CRPR`-Cash collateral related to a combination of various types of trades.\n*`CRSP`-Cash collateral related to cash lending/borrowing; letter of Credit; signing of master agreement.\n*`CRTL`-Cash collateral related to opening of a credit line before trading.\n*`EQPT`-Cash collateral related to trading of equity option (Also known as stock options).\n*`EQUS`-Cash collateral related to equity swap trades where the return of an equity is exchanged for either a fixed or a floating rate of interest.\n*`EXPT`-Cash collateral related to trading of an exotic option for example a non-standard option.\n*`EXTD`-Cash collateral related to trading of exchanged traded derivatives in general (Opposite to Over the Counter (OTC)).\n*`FIXI`-Cash collateral related to a fixed income instrument\n*`FWBC`-Cash collateral payment against a Master Forward Agreement (MFA) where the cash is held in a segregated account and is not available for use by the client. Includes any instruments with a forward settling date such TBAs, repurchase agreements and bond forwards\n*`FWCC`-Cash collateral payment against a Master Forward Agreement (MFA) where the cash is owned and may be used by the client when returned. Includes any instruments with a forward settling date such TBAs, repurchase agreements and bond forwards\n*`FWSB`-Any cash payment related to the collateral for a Master Agreement forward, which is segregated, and not available for use by the client. Example master agreement forwards include TBA, repo and Bond Forwards.\n*`FWSC`-Any cash payment related to the collateral for a Master agreement forward, which is owned by the client and is available for use by the client when it is returned to them from the segregated account. Example master agreement forwards include TBA, repo and Bond Forwards.\n*`MARG`-Daily margin on listed derivatives – not segregated as collateral associated with an FCM agreement. Examples include listed futures and options margin payments; premiums for listed options not covered in the MT54X message.\n*`MBSB`-MBS Broker Owned Segregated (40Act/Dodd Frank) Cash Collateral - Any cash payment related to the collateral for a Mortgage Back Security, which is segregated, and not available for use by the client.\n*`MBSC`-MBS Client Owned Cash Segregated (40Act/Dodd Frank) Cash Collateral - Any cash payment related to the collateral for a Mortgage Back Security, which is owned by the client and is available for use by the client when it is returned to them from the segregated account\n*`MGCC`-Initial futures margin. Where such payment is owned by the client and is available for use by them on return\n*`MGSC`-Margin Client Owned Segregated Cash Collateral - Any cash payment related to the collateral for initial futures margin, which is owned by the client and is available for use by the client when it is returned to them from the segregated account.\n*`OCCC`-Client owned collateral identified as eligible for OCC pledging.\n*`OPBC`-Cash collateral payment for OTC options associated with an FCM agreement. Where such payment is segregated and not available for use by the client\n*`OPCC`-Cash collateral payment for OTC options associated with an FCM agreement. Where such payment is not segregated and is available for use by the client upon return\n*`OPSB`-Option Broker Owned Segregated Cash Collateral - Any cash payment related to the collateral for an OTC option, which is segregated, and not available for use by the client.\n*`OPSC`-Option Client Owned Cash Segregated Cash Collateral - Any cash payment related to the collateral for an OTC option, which is owned by the client and is available for use by the client when it is returned to them from the segregated account\n*`OPTN`-Cash collateral related to trading of option on Foreign Exchange.\n*`OTCD`-Cash collateral related to Over-the-counter (OTC) Derivatives in general for example contracts which are traded and privately negotiated.\n*`REPO`-Cash collateral related to a repurchase agreement transaction.\n*`RPBC`-Bi-lateral repo broker owned collateral associated with a repo master agreement – GMRA or MRA Master Repo Agreements.\n*`RPCC`-Repo client owned collateral associated with a repo master agreement – GMRA or MRA Master Repo Agreements\n*`RPSB`-Bi-lateral repo broker owned segregated cash collateral associated with a repo master agreement.\n*`RPSC`-Repo client owned segregated collateral associated with a repo master agreement.\n*`RVPO`-Cash collateral related to a reverse repurchase agreement transaction.\n*`SBSC`-Cash collateral related to a Securities Buy Sell Sell Buy Back\n*`SCIE`-Cash collateral related to Exotic single currency interest rate swap.\n*`SCIR`-Cash collateral related to Single Currency Interest Rate Swap.\n*`SCRP`-Cash collateral related to Combination of securities-related exposure types.\n*`SHBC`-Short Sale broker owned collateral associated with a prime broker agreement.\n*`SHCC`-Short Sale client owned collateral associated with a prime brokerage agreement.\n*`SHSL`-Cash Collateral related to a Short Sell\n*`SLEB`-Cash collateral related to Securities lending and borrowing.\n*`SLOA`-Cash collateral related to a Secured loan.\n*`SWBC`-Cash collateral payment for swaps associated with an ISDA agreement. . Where such payment is segregated and\nnot available for use by the client. Includes any cash collateral payments made under the terms of a CSA agreement\nfor instruments such as swaps and FX forwards.\n*`SWCC`-Cash collateral payment for swaps associated with an ISDA agreement. Where such payment is not segregated and\nis available for use by the client upon return. Includes any cash collateral payments made under the terms of a CSA\nagreement for instruments such as swaps and FX forwards.\n*`SWPT`-Cash collateral related to an option on interest rate swap.\n*`SWSB`-Swaps Broker Owned Segregated Cash Collateral - Any cash payment related to the collateral for Swap margin ,\nwhich is segregated, and not available for use by the client. This includes any collateral identified in a CSA\nagreement such as Swap or FX Forward collateral.\n*`SWSC`-Swaps Client Owned Segregated Cash Collateral - Any cash payment related to the collateral for Swap margin,\nwhich is owned by the client and is available for use by the client when returned from the segregated account. This\nincludes any collateral identified in a CSA agreement such as Swap or FX Forward collateral.\n*`TBAS`-Cash collateral related to a To Be Announced (TBA)\n*`TBBC`-Cash collateral payment (segregated) for TBA securities associated with a TBA Master Agreement. Where such payment is segregated and not available for use by the client.\n*`TBCC`-Cash collateral payment (for use by client)for TBA securities associated with a TBA Master Agreement. Where such payment is not segregated and is available for use by the client upon return.\n*`TRCP`-Cash collateral related to a combination of treasury-related exposure types.\n*`AGRT`-Transaction is related to the agricultural domain.\n*`AREN`-Transaction is related to a payment associated with an Account Receivable Entry\n*`BEXP`-Transaction is related to a payment of business expenses.\n*`BOCE`-Transaction is related to a payment associated with a Back Office Conversion Entry\n*`COMC`-Transaction is related to a payment of commercial credit or debit. (formerly CommercialCredit).\n*`CPYR`-Transaction is payment of copyright.\n*`GDDS`-Transaction is related to purchase and sale of goods.\n*`GDSV`-Transaction is related to purchase and sale of goods and services.\n*`GSCB`-Transaction is related to purchase and sale of goods and services with cash back.\n*`LICF`-Transaction is payment of a license fee.\n*`MP2B`-A service which enables a user to use an app on its mobile to pay a merchant or other business payees by initiating a payment message. Within this context, the account information or an alias of the payee might be transported through different channels to the app, for example QR Code, NFC, Bluetooth, other Networks.\n*`POPE`-Transaction is related to a payment associated with a Point of Purchase Entry.\n*`ROYA`-Transaction is the payment of royalties.\n*`SCVE`-Transaction is related to purchase and sale of services.\n*`SERV`-Transaction is related to service charges charged by a service provider.\n*`SUBS`-Transaction is related to a payment of information or entertainment services either in printed or electronic form.\n*`SUPP`-Transaction is related to a payment to a supplier.\n*`TRAD`-Transaction is related to a trade services operation.\n*`CHAR`-Transaction is a payment for charity reasons.\n*`COMT`-Transaction is a payment used by a third party who can collect funds to pay on behalf of consumers, ie credit counseling or bill payment companies.\n*`MP2P`-A service which enables a user to use an app on its mobile to initiate moving funds from his/her bank account to another person’s bank account while not using the account number  but an alias information like an MSISDN as account addressing information in his/her app.\n*`ECPG`-E-Commerce payment with payment guarantee of the issuing bank.\n*`ECPR`-E-Commerce payment return.\n*`ECPU`-E-Commerce payment without payment guarantee of the issuing bank.\n*`EPAY`-Transaction is related to ePayment.\n*`CLPR`-Transaction is a payment of car loan principal payment.\n*`COMP`-Transaction is related to the payment of a compensation relating to interest loss/value date adjustment and can include fees.\n*`DBTC`-Collection of funds initiated via a debit transfer.\n*`GOVI`-Transaction is related to a payment of government insurance.\n*`HLRP`-Transaction is related to a payment of property loan.\n*`HLST`-Transaction is related to the settlement of a property loan.\n*`INPC`-Transaction is a payment of car insurance premium.\n*`INPR`-Transaction is related to an insurance premium refund.\n*`INSC`-Transaction is related to the payment of an insurance claim.\n*`INSU`-Transaction is payment of an insurance premium.\n*`INTE`-Transaction is payment of interest.\n*`LBRI`-Transaction is a payment of labor insurance.\n*`LIFI`-Transaction is a payment of life insurance.\n*`LOAN`-Transaction is related to transfer of loan to borrower.\n*`LOAR`-Transaction is related to repayment of loan to lender.\n*`PENO`-Payment based on enforcement orders except those arising from judicial alimony decrees.\n*`PPTI`-Transaction is a payment of property insurance.\n*`RELG`-Transaction is for general rental/lease.\n*`RINP`-Transaction is related to a payment of a recurring installment made at regular intervals.\n*`TRFD`-Transaction is related to a payment of a trust fund.\n*`FORW`-FX trades with a value date in the future.\n*`FXNT`-FX netting if cash is moved by separate wire instead of within the closing FX instruction\n*`ADMG`-Transaction is related to a payment associated with administrative management.\n*`ADVA`-Transaction is an advance payment.\n*`BCDM`-Transaction is the payment of a domestic bearer cheque.\n*`BCFG`-Transaction is the payment of a foreign bearer cheque.\n*`BLDM`-Transaction is related to a payment associated with building maintenance.\n*`BNET`-Bond Forward pair-off cash net movement.\n*`CBFF`-Transaction is related to capital building fringe fortune, ie capital building in general.\n*`CBFR`-Transaction is related to capital building fringe fortune for retirement.\n*`CCRD`-Transaction is related to a payment of credit card account.\n*`CDBL`-Transaction is related to a payment of credit card bill.\n*`CFEE`-Transaction is related to a payment of cancellation fee.\n*`CGDD`-Transaction is related to a direct debit where the mandate was generated by using data from a payment card at the point of sale.\n*`CORT`-Transaction is related to settlement of a trade, e.g. a foreign exchange deal or a securities transaction.\n*`COST`-Transaction is related to payment of costs.\n*`CPKC`-Transaction is related to carpark charges.\n*`DCRD`-Transaction is related to a debit card payment.\n*`DSMT`-Transaction is the payment of a disbursement due to a specific type of printed order for a payment of a  specified sum, issued by a bank or a post office (Zahlungsanweisung zur Verrechnung)\n*`DVPM`-Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.\n*`EDUC`-Transaction is related to a payment of study/tuition fees.\n*`FACT`-Payment related to a factor update\n*`FAND`-Financial aid by State authorities for abolition of consequences of natural disasters.\n*`FCPM`-Transaction is the payment for late fees & charges. E.g Credit card charges\n*`FEES`-Payment of fees/charges.\n*`GIFT`-Payment with no commercial or statutory purpose.\n*`GOVT`-Transaction is a payment to or from a government department.\n*`ICCP`-Transaction is reimbursement of credit card payment.\n*`IDCP`-Transaction is reimbursement of debit card payment.\n*`IHRP`-Transaction is payment for an installment/hire-purchase agreement.\n*`INSM`-Transaction is related to a payment of an installment.\n*`IVPT`-Transaction is the payment for invoices.\n*`MCDM`-Transaction is the payment of a domestic multi-currency cheque\n*`MCFG`-Transaction is the payment of a foreign multi-currency cheque\n*`MSVC`-Transaction is related to a payment for multiple service types.\n*`NOWS`-Transaction is related to a payment for type of services not specified elsewhere.\n*`OCDM`-Transaction is the payment of a domestic order cheque\n*`OCFG`-Transaction is the payment of a foreign order cheque\n*`OFEE`-Transaction is related to a payment of opening fee.\n*`OTHR`-Other payment purpose.\n*`PADD`-Transaction is related to a pre-authorized debit origination\n*`PTSP`-Transaction is related to payment terms specifications\n*`RCKE`-Transaction is related to a payment associated with a re-presented check entry\n*`RCPT`-Transaction is related to a payment of receipt.\n*`REBT`-Transaction is the payment of a rebate.\n*`REFU`-Transaction is the payment of a refund.\n*`RENT`-Transaction is the payment of rent.\n*`REOD`-Transaction is for account overdraft repayment\n*`RIMB`-Transaction is related to a reimbursement of a previous erroneous transaction.\n*`RPNT`-Bi-lateral repo interest net/bulk payment at rollover/pair-off or other closing scenarios where applicable.\n*`RRBN`-Cash payment resulting from a Round Robin\n*`RRCT`-Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer.\n*`RRTP`-Transaction is related to a Request to Pay.\n*`RVPM`-Code used to pre-advise the account servicer of a forthcoming receive against payment instruction.\n*`SLPI`-Transaction is payment of a well formatted payment slip.\n*`SPLT`-Split payments. To be used when cash and security movements for a security trade settlement are instructed\nseparately.\n*`STDY`-Transaction is related to a payment of study/tuition costs.\n*`TBAN`-TBA pair-off cash wire net movement\n*`TBIL`-Transaction is related to a payment of telecommunications related bill.\n*`TCSC`-Transaction is related to a payment associated with charges levied by a town council.\n*`TELI`-Transaction is related to a payment initiated via telephone.\n*`TMPG`-Cash payment resulting from a TMPG Claim\n*`TPRI`-Tri-Party Repo related interest\n*`TPRP`-Tri-party Repo related net gain/loss cash movement\n*`TRNC`-Transaction is payment of a beneficiary prefilled payment slip where beneficiary to payer information is truncated.\n*`TRVC`-Transaction is the payment of a travellers cheque\n*`WEBI`-Transaction is related to a payment initiated via internet.\n*`IPAY`-Transaction in which the amount is available to the payee immediately.\n*`IPCA`-Transaction in which the Return of the amount is fully returned.\n*`IPDO`-Transaction in which the amount is available to the payee immediately, done for donations, with sending the address data of the payer.\n*`IPEA`-Transaction in which the amount is available to the payee immediately, done in E-commerce, without sending the address data of the payer.\n*`IPEC`-Transaction in which the amount is available to the payee immediately, done in E-commerce, with sending the address data of the payer.\n*`IPEW`-Transaction in which the amount is available to the payee immediately, done in E-commerce.\n*`IPPS`-Transaction in which the amount is available to the payee immediately, done at POS.\n*`IPRT`-Transaction in which the Return of the amount is fully or partial returned.\n*`IPU2`-Transaction is made via an unattending vending machine by using 2-factor-authentification.\n*`IPUW`-Transaction is made via an unattending vending machine by without using 2-factor-authentification.\n*`ANNI`-Transaction settles annuity related to credit, insurance, investments, other.n\n*`CAFI`-Transaction is the payment of custodian account management fee where custodian bank and current account servicing bank coincide.\n*`CFDI`-Transaction is the payment of capital falling due where custodian bank and current account servicing bank coincide.\n*`CMDT`-Transaction is payment of commodities.\n*`DERI`-Transaction is related to a derivatives transaction.\n*`DIVD`-Transaction is payment of dividends.\n*`FREX`-Transaction is related to a foreign exchange operation.\n*`HEDG`-Transaction is related to a hedging operation.\n*`INVS`-Transaction is for the payment of mutual funds, investment products and shares\n*`PRME`-Transaction is related to a precious metal operation.\n*`SAVG`-Transfer to / from savings or to retirement account.\n*`SECU`-Transaction is the payment of securities.\n*`SEPI`-Transaction is the payment of a purchase of securities where custodian bank and current account servicing bank coincide\n*`TREA`-Transaction is related to treasury operations.\n*`UNIT`-Transaction is purchase of Unit Trust\n*`FNET`-Cash associated with a netting of futures payments. Refer to CCPM codeword for netting of initial and variation margin through a CCP\n*`FUTR`-Cash related to futures trading activity.\n*`ANTS`-Transaction is a payment for anesthesia services.\n*`CVCF`-Transaction is a payment for convalescence care facility services.\n*`DMEQ`-Transaction is a payment is for use of durable medical equipment.\n*`DNTS`-Transaction is a payment for dental services.\n*`HLTC`-Transaction is a payment for home health care services.\n*`HLTI`-Transaction is a payment of health insurance.\n*`HSPC`-Transaction is a payment for hospital care services.\n*`ICRF`-Transaction is a payment for intermediate care facility services.\n*`LTCF`-Transaction is a payment for long-term care facility services.\n*`MAFC`-Transaction is contribution to medical aid fund.\n*`MARF`-Transaction is related to a medical aid refund.\n*`MDCS`-Transaction is a payment for medical care services.\n*`VIEW`-Transaction is a payment for vision care services.\n*`CDEP`-Payment related to a credit default event.\n*`SWFP`-Final payments for a swap contract\n*`SWPP`-Partial payment for a swap contract\n*`SWRS`-Reset payment for a swap contract\n*`SWUF`-Upfront payment for a swap contract\n*`ADCS`-Payments for donation, sponsorship, advisory, intellectual and other copyright services.\n*`AEMP`-Payment concerning active employment policy.\n*`ALLW`-Transaction is the payment of allowances.\n*`ALMY`-Transaction is the payment of alimony.\n*`BBSC`-Transaction is related to a payment made as incentive to encourage parents to have more children\n*`BECH`-Transaction is related to a payment made to assist parent/guardian to maintain child.\n*`BENE`-Transaction is related to a payment to a person who is unemployed/disabled.\n*`BONU`-Transaction is related to payment of a bonus.\n*`CCHD`-Payments made by Government institute related to cash compensation, helplessness, disability. These payments are made by the Government institution as a social benefit in addition to regularly paid salary or pension.\n*`COMM`-Transaction is payment of commission.\n*`CSLP`-Transaction is a payment by a company to a bank for financing social loans to employees.\n*`GFRP`-Compensation to unemployed persons during insolvency procedures.\n*`GVEA`-Transaction is payment to category A Austrian government employees.\n*`GVEB`-Transaction is payment to category B Austrian government employees.\n*`GVEC`-Transaction is payment to category C Austrian government employees.\n*`GVED`-Transaction is payment to category D Austrian government employees.\n*`GWLT`-Payment to victims of war violence and to disabled soldiers.\n*`HREC`-Transaction is a contribution by an employer to the housing expenditures (purchase, construction, renovation) of the employees within a tax free fringe benefit system \n*`PAYR`-Transaction is related to the payment of payroll.\n*`PEFC`-Transaction is contribution to pension fund.\n*`PENS`-Transaction is the payment of pension.\n*`PRCP`-Transaction is related to a payment of a price.\n*`RHBS`-Benefit for the duration of occupational rehabilitation.\n*`SALA`-Transaction is the payment of salaries.\n*`SPSP`-Salary or pension payment for more months in one amount or a delayed payment of salaries or pensions.\n*`SSBE`-Transaction is a social security benefit, ie payment made by a government to support individuals.\n*`LBIN`-Net payment related to a buy-in. When an investment manager is bought in on a sell trade that fails due to a failed securities lending recall, the IM may seize the underlying collateral to pay for the buy-in. Any difference between the value of the collateral and the sell proceeds would be paid or received under this code\n*`LCOL`-Free movement of cash collateral. Cash collateral paid by the borrower is done separately from the delivery of the shares at loan opening or return of collateral done separately from return of the loaned security. Note: common when the currency of the security is different the currency of the cash collateral.\n*`LFEE`-Fee payments, other than rebates, for securities lending. Includes (a) exclusive fees; (b) transaction fees; (c)\ncustodian fees; (d) minimum balance fees\n*`LMEQ`-Cash collateral payments resulting from the marked-to-market of a portfolio of loaned equity securities\n*`LMFI`-Cash collateral payments resulting from the marked-to-market of a portfolio of loaned fixed income securities\n*`LMRK`-Cash collateral payments resulting from the marked-to-market of a portfolio of loaned securities where the instrument\ntypes are not specified\n*`LREB`-Securities lending rebate payments\n*`LREV`-Revenue payments made by the lending agent to the client\n*`LSFL`-Payments made by a borrower to a lending agent to satisfy claims made by the investment manager related to sell fails from late loan recall deliveries\n*`ESTX`-Transaction is related to a payment of estate tax.\n*`FWLV`-Transaction is related to a payment of Foreign Worker Levy\n*`GSTX`-Transaction is the payment of Goods & Services Tax\n*`HSTX`-Transaction is related to a payment of housing tax.\n*`INTX`-Transaction is related to a payment of income tax.\n*`NITX`-Transaction is related to a payment of net income tax.\n*`PTXP`-Transaction is related to a payment of property tax.\n*`RDTX`-Transaction is related to a payment of road tax.\n*`TAXS`-Transaction is the payment of taxes.\n*`VATX`-Transaction is the payment of value added tax.\n*`WHLD`-Transaction is related to a payment of withholding tax.\n*`TAXR`-Transaction is the refund of a tax payment or obligation.\n*`B112`-US mutual fund trailer fee (12b-1) payment\n*`BR12`-US mutual fund trailer fee (12b-1) rebate payment\n*`TLRF`-Any non-US mutual fund trailer fee (retrocession) payment (use ISIN to determine onshore versus offshore designation)\n*`TLRR`-Any non-US mutual fund trailer fee (retrocession) rebate payment (use ISIN to determine onshore versus offshore designation)\n*`AIRB`-Transaction is a payment for air transport related business.\n*`BUSB`-Transaction is a payment for bus transport related business.\n*`FERB`-Transaction is a payment for ferry related business.\n*`RLWY`-Transaction is a payment for railway transport related business.\n*`TRPT`-Transaction is for the payment to top-up pre-paid card and electronic road pricing for the purpose of transportation\n*`CBTV`-Transaction is related to a payment of cable TV bill.\n*`ELEC`-Transaction is related to a payment of electricity bill.\n*`ENRG`-Transaction is related to a utility operation.\n*`GASB`-Transaction is related to a payment of gas bill.\n*`NWCH`-Transaction is related to a payment of network charges.\n*`NWCM`-Transaction is related to a payment of network communication.\n*`OTLC`-Transaction is related to a payment of other telecom related bill.\n*`PHON`-Transaction is related to a payment of telephone bill.\n*`UBIL`-Transaction is for the payment to common utility provider that provide gas, water and/or electricity.\n*`WTER`-Transaction is related to a payment of water bill.\n*`BOND`-Securities Lending-Settlement of Bond transaction.\n*`CABD`-Securities Lending-Settlement of Corporate Actions: Bonds transactions.\n*`CAEQ`-Securities Lending-Settlement of Corporate Actions: Equities transactions.\n*`CBCR`-Card Settlement-Settlement of Credit Card transactions.\n*`DBCR`-Card Settlement-Settlement of Debit Card transactions.\n*`DICL`-Card Settlement-Settlement of Diners transactions.\n*`EQTS`-Securities Lending-Settlement of Equities transactions.\n*`FLCR`-Card Settlement-Settlement of Fleet transactions.\n*`EFTC`-Utilities-Settlement of Low value Credit transactions.\n*`EFTD`-Utilities-Settlement of Low value Debit transactions.\n*`MOMA`-Securities Lending-ettlement of Money Market PCH.\n*`RAPI`-Instant Payments-Settlement of Rapid Payment Instruction (RPI) transactions.\n*`GAMB`-General-Payments towards a purchase or winnings received from gambling, betting or other wagering activities.\n*`LOTT`-General-Payment towards a purchase or winnings received from lottery activities.\n*`AMEX`-Card Settlement-Settlement of AMEX transactions.\n*`SASW`-Card Settlement-Settlement of ATM transactions.\n*`AUCO`-Utilities-Settlement of Authenticated Collections transactions.\n*`PCOM`-Final payment to complete the purchase of a property.\n*`PDEP`-Payment of the deposit required towards purchase of a property.\n*`PLDS`-Payment of funds from a lender as part of the issuance of a property loan.\n*`PLRF`-Transfer or extension of a property financing arrangement to a new deal or loan provider, without change of ownership of property.\n*`GAFA`-Salary and Benefits-Allowance from government to support family.\n*`GAHO`-Salary and Benefits-Allowance from government to individuals to support payments of housing.\n*`CPEN`-Cash penalties related to securities transaction, including CSDR Settlement Discipline Regime.\n*`DEPD`-Transaction is related to a payment concerning dependent support, for example child support or support for a person substantially financially dependent on the support provider.\n*`RETL`-Retail payment including e-commerce and online shopping.\n*`DEBT`-Purpose of payment is the settlement of charges payable by the debtor in relation to an underlying customer credit transfer.\n*`RMCO`-Utilities-Settlement of Unauthenticated Collections transactions.\n*`INBC`-Settlement of charges in response to a prior interbank charge request.\n*`LBXX`-Transaction is related to a cash transfer from an underlying fund to a holding collateralization account (ie. Longbox) for potential further use as collateral or back to the fund in case it is not required anymore.\n*`MFSR`-Payment related to shares settlement of a subscription or redemption order."
      enum:
        - BKDF
        - BKFE
        - BKFM
        - BKIP
        - BKPP
        - CBLK
        - CDCB
        - CDCD
        - CDCS
        - CDDP
        - CDOC
        - CDQC
        - ETUP
        - FCOL
        - MTUP
        - ACCT
        - CASH
        - COLL
        - CSDB
        - DEPT
        - INTC
        - INTP
        - LIMA
        - NETT
        - BFWD
        - CCIR
        - CCPC
        - CCPM
        - CCSM
        - CRDS
        - CRPR
        - CRSP
        - CRTL
        - EQPT
        - EQUS
        - EXPT
        - EXTD
        - FIXI
        - FWBC
        - FWCC
        - FWSB
        - FWSC
        - MARG
        - MBSB
        - MBSC
        - MGCC
        - MGSC
        - OCCC
        - OPBC
        - OPCC
        - OPSB
        - OPSC
        - OPTN
        - OTCD
        - REPO
        - RPBC
        - RPCC
        - RPSB
        - RPSC
        - RVPO
        - SBSC
        - SCIE
        - SCIR
        - SCRP
        - SHBC
        - SHCC
        - SHSL
        - SLEB
        - SLOA
        - SWBC
        - SWCC
        - SWPT
        - SWSB
        - SWSC
        - TBAS
        - TBBC
        - TBCC
        - TRCP
        - AGRT
        - AREN
        - BEXP
        - BOCE
        - COMC
        - CPYR
        - GDDS
        - GDSV
        - GSCB
        - LICF
        - MP2B
        - POPE
        - ROYA
        - SCVE
        - SERV
        - SUBS
        - SUPP
        - TRAD
        - CHAR
        - COMT
        - MP2P
        - ECPG
        - ECPR
        - ECPU
        - EPAY
        - CLPR
        - COMP
        - DBTC
        - GOVI
        - HLRP
        - HLST
        - INPC
        - INPR
        - INSC
        - INSU
        - INTE
        - LBRI
        - LIFI
        - LOAN
        - LOAR
        - PENO
        - PPTI
        - RELG
        - RINP
        - TRFD
        - FORW
        - FXNT
        - ADMG
        - ADVA
        - BCDM
        - BCFG
        - BLDM
        - BNET
        - CBFF
        - CBFR
        - CCRD
        - CDBL
        - CFEE
        - CGDD
        - CORT
        - COST
        - CPKC
        - DCRD
        - DSMT
        - DVPM
        - EDUC
        - FACT
        - FAND
        - FCPM
        - FEES
        - GIFT
        - GOVT
        - ICCP
        - IDCP
        - IHRP
        - INSM
        - IVPT
        - MCDM
        - MCFG
        - MSVC
        - NOWS
        - OCDM
        - OCFG
        - OFEE
        - OTHR
        - PADD
        - PTSP
        - RCKE
        - RCPT
        - REBT
        - REFU
        - RENT
        - REOD
        - RIMB
        - RPNT
        - RRBN
        - RRCT
        - RRTP
        - RVPM
        - SLPI
        - SPLT
        - STDY
        - TBAN
        - TBIL
        - TCSC
        - TELI
        - TMPG
        - TPRI
        - TPRP
        - TRNC
        - TRVC
        - WEBI
        - IPAY
        - IPCA
        - IPDO
        - IPEA
        - IPEC
        - IPEW
        - IPPS
        - IPRT
        - IPU2
        - IPUW
        - ANNI
        - CAFI
        - CFDI
        - CMDT
        - DERI
        - DIVD
        - FREX
        - HEDG
        - INVS
        - PRME
        - SAVG
        - SECU
        - SEPI
        - TREA
        - UNIT
        - FNET
        - FUTR
        - ANTS
        - CVCF
        - DMEQ
        - DNTS
        - HLTC
        - HLTI
        - HSPC
        - ICRF
        - LTCF
        - MAFC
        - MARF
        - MDCS
        - VIEW
        - CDEP
        - SWFP
        - SWPP
        - SWRS
        - SWUF
        - ADCS
        - AEMP
        - ALLW
        - ALMY
        - BBSC
        - BECH
        - BENE
        - BONU
        - CCHD
        - COMM
        - CSLP
        - GFRP
        - GVEA
        - GVEB
        - GVEC
        - GVED
        - GWLT
        - HREC
        - PAYR
        - PEFC
        - PENS
        - PRCP
        - RHBS
        - SALA
        - SPSP
        - SSBE
        - LBIN
        - LCOL
        - LFEE
        - LMEQ
        - LMFI
        - LMRK
        - LREB
        - LREV
        - LSFL
        - ESTX
        - FWLV
        - GSTX
        - HSTX
        - INTX
        - NITX
        - PTXP
        - RDTX
        - TAXS
        - VATX
        - WHLD
        - TAXR
        - B112
        - BR12
        - TLRF
        - TLRR
        - AIRB
        - BUSB
        - FERB
        - RLWY
        - TRPT
        - CBTV
        - ELEC
        - ENRG
        - GASB
        - NWCH
        - NWCM
        - OTLC
        - PHON
        - UBIL
        - WTER
        - BOND
        - CABD
        - CAEQ
        - CBCR
        - DBCR
        - DICL
        - EQTS
        - FLCR
        - EFTC
        - EFTD
        - MOMA
        - RAPI
        - GAMB
        - LOTT
        - AMEX
        - SASW
        - AUCO
        - PCOM
        - PDEP
        - PLDS
        - PLRF
        - GAFA
        - GAHO
        - CPEN
        - DEPD
        - RETL
        - DEBT
        - RMCO
        - INBC
        - LBXX
        - MFSR
    ExternalServiceLevel1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the external service level code in the format of character string with a maximum length of 4 characters.\r\nThe list of valid codes is an external code list published separately.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`BKTR`-Payment through internal book transfer.\n*`G001`-Tracked Customer Credit Transfer.\n*`G002`-Tracked Stop and Recall \n*`G003`-Tracked Outbound Corporate Transfer.\n*`G004`-Tracked Financial Institution Transfer.\n*`NPCA`-Payments must be executed following the NPC Area Payment scheme.\n*`NUGP`-Payment must be executed as a non-urgent transaction with priority settlement.\n*`NURG`-Payment must be executed as a non-urgent transaction, which is typically identified as an ACH or low value transaction. \n*`PRPT`-Transaction must be processed according to the EBA Priority Service.\n*`SDVA`-Payment must be executed with same day value to the creditor.\n*`SEPA`-Payment must be executed following the Single Euro Payments Area scheme.\n*`SVDE`-Payment execution following the cheque agreement and traveller cheque agreement of the German Banking Industry Committee (Die Deutsche Kreditwirtschaft - DK) and Deutsche Bundesbank – Scheck Verrechnung Deutschland\n*`URGP`-Payment must be executed as an urgent transaction cleared through a real-time gross settlement system, which is typically identified as a wire or high value transaction.  \n*`URNS`-Payment must be executed as an urgent transaction cleared through a real-time net settlement system, which is typically identified as a wire or high value transaction.  \n*`INST`-Used for payment initiation to identify that a Payment or Direct Debit initiation must be executed as an instant or real-time payment instrument.\n*`SRTP`-Request to Pay (RTP) transaction refers to an RTP scheme (such as for example the SEPA Request to Pay (SRTP) scheme).\n*`SVAT`-Scheck Verarbeitung Austria (Cheque Processing).\n*`G006`-Specifies the service conditions applicable to a tracked exceptions and investigations case.\n*`G007`-Specifies the service level for a tracked inbound customer credit transfer.\n*`G005`-Tracked Instant Customer Credit Transfer.\r\n\r\n\n*`G009`-Specifies the service level for a tracked low-value cross-border customer credit transfer.\n*`WFSM`-Transaction is to be treated as an advice and only applied to the account of the creditor or next agent after settlement of the cover has been confirmed.\n*`EOLO`-Payment is executed following a Euro One-Leg Out Scheme.\n*`SPLI`-A split payment is a payment that is split into several payments of lower value, namely with the purpose to comply with maximum amount thresholds applicable to some domestic Payment Market Infrastructures or to reduce counterparty liquidity risk.\n*`IRCA`-Payment must be executed following the Icelandic Rulebook Council Area (IRCA) scheme.\n*`EAPS`-Identifies payments executed under the East African Payment System (EAPS), the regional cross-border settlement scheme operated by EAC central banks."
      enum:
        - BKTR
        - G001
        - G002
        - G003
        - G004
        - NPCA
        - NUGP
        - NURG
        - PRPT
        - SDVA
        - SEPA
        - SVDE
        - URGP
        - URNS
        - INST
        - SRTP
        - SVAT
        - G006
        - G007
        - G005
        - G009
        - WFSM
        - EOLO
        - SPLI
        - IRCA
        - EAPS
    ExternalStatusReason1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the status reason, as published in an external status reason code list.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`AB01`-Clearing process aborted due to timeout.   \n*`AB02`-Clearing process aborted due to a fatal error.\_ \_\n*`AB03`-Settlement aborted due to timeout.\_ \_\n*`AB04`-Settlement process aborted due to a fatal error.\_ \_\n*`AB05`-Transaction stopped due to timeout at the Creditor Agent.\n*`AB06`-Transaction stopped due to timeout at the Instructed Agent.\n*`AB07`-Agent of message is not online.\nGeneric usage if it cannot be determined who exactly is not online.\n*`AB08`-Creditor Agent is not online.\n*`AB09`-Transaction stopped due to error at the Creditor Agent.\n*`AB10`-Transaction stopped due to error at the Instructed Agent.\n*`AB11`-Transaction stopped due to timeout at the Debtor Agent.\n*`AC01`-Account number is invalid or missing.   \n\n*`AC02`-Debtor account number invalid or missing\n*`AC03`-Creditor account number invalid or missing\n*`AC04`-Account number specified has been closed on the bank of account's books. \n*`AC05`-Debtor account number closed\n*`AC06`-Account specified is blocked, prohibiting posting of transactions against it.\n*`AC07`-Creditor account number closed\n*`AC08`-Branch code is invalid or missing\n*`AC09`-Account currency is invalid or missing\n*`AC10`-Debtor account currency is invalid or missing\n*`AC11`-Creditor account currency is invalid or missing\n*`AC12`-Account type missing or invalid.\nGeneric usage if cannot specify between group and payment information levels\n*`AC13`-Debtor account type missing or invalid\n*`AC14`-Creditor account type missing or invalid\n*`AC15`-The account details for the counterparty have changed.\n*`AC16`-Credit or debit card number is invalid.\n*`AG01`-Transaction forbidden on this type of account (formerly NoAgreement)\n*`AG02`-Bank Operation code specified in the message is not valid for receiver\n*`AG03`-Transaction type not supported/authorized on this account \n*`AG04`-Agent country code is missing or invalid.\nGeneric usage if cannot specify between group and payment information levels.\n*`AG05`-Debtor agent country code is missing or invalid\n*`AG06`-Creditor agent country code is missing or invalid\n*`AG07`-Debtor account cannot be debited for a generic reason.\nCode value may be used in general purposes and as a replacement for AM04 if debtor bank does not reveal its customer's insufficient funds for privacy reasons\n*`AG08`-Transaction failed due to invalid or missing user or access right\n*`AG09`-Original payment never received.\n*`AG10`-Agent of message is suspended from the Real Time Payment system.\nGeneric usage if it cannot be determined who exactly is suspended.\n*`AG11`-Creditor Agent of message is suspended from the Real Time Payment system.\n*`AG12`-Payment orders made by transferring funds from one account to another at the same financial institution (bank or payment institution) are not allowed.\n*`AG13`-Returned payments derived from previously returned transactions are not allowed.\n*`AGNT`-Agent in the payment workflow is incorrect\n*`AM01`-Specified message amount is equal to zero\n*`AM02`-Specific transaction/message amount is greater than allowed maximum\n*`AM03`-Specified message amount is an non processable currency outside of existing agreement\n*`AM04`-Amount of funds available to cover specified message amount is insufficient.\n*`AM05`-Duplication\n*`AM06`-Specified transaction amount is less than agreed minimum.\n*`AM07`-Amount specified in message has been blocked by regulatory authorities.\n*`AM09`-Amount received is not the amount agreed or expected\n*`AM10`-Sum of instructed amounts does not equal the control sum.\n*`AM11`-Transaction currency is invalid or missing\n*`AM12`-Amount is invalid or missing\n*`AM13`-Transaction amount exceeds limits set by clearing system\n*`AM14`-Transaction amount exceeds limits agreed between bank and client\n*`AM15`-Transaction amount below minimum set by clearing system\n*`AM16`-Control Sum at the Group level is invalid\n*`AM17`-Control Sum at the Payment Information level is invalid\n*`AM18`-Number of transactions is invalid or missing.\nGeneric usage if cannot specify between group and payment information levels.\n*`AM19`-Number of transactions at the Group level is invalid or missing\n*`AM20`-Number of transactions at the Payment Information level is invalid\n*`AM21`-Transaction amount exceeds limits agreed between bank and client.\n*`AM22`-Unable to apply zero amount to designated account. For example, where the rules of a service allow the use of zero amount payments, however the back-office system is unable to apply the funds to the account. If the rules of a service prohibit the use of zero amount payments, then code AM01 is used to report the error condition.\n*`AM23`-Transaction amount exceeds settlement limit.\n*`BE01`-Identification of end customer is not consistent with associated account number. (formerly CreditorConsistency).\n*`BE04`-Specification of creditor's address, which is required for payment, is missing/not correct (formerly IncorrectCreditorAddress).\n*`BE05`-Party who initiated the message is not recognised by the end customer\n*`BE06`-End customer specified is not known at associated Sort/National Bank Code or does no longer exist in the books\n*`BE07`-Specification of debtor's address, which is required for payment, is missing/not correct.\n*`BE08`-Debtor name is missing\n*`BE09`-Country code is missing or Invalid.\nGeneric usage if cannot specifically identify debtor or creditor\n*`BE10`-Debtor country code is missing or invalid\n*`BE11`-Creditor country code is missing or invalid\n*`BE12`-Country code of residence is missing or Invalid.\nGeneric usage if cannot specifically identify debtor or creditor\n*`BE13`-Country code of debtor's residence is missing or Invalid\n*`BE14`-Country code of creditor's residence is missing or Invalid\n*`BE15`-Identification code missing or invalid.\nGeneric usage if cannot specifically identify debtor or creditor.\n*`BE16`-Debtor or Ultimate Debtor identification code missing or invalid\n*`BE17`-Creditor or Ultimate Creditor identification code missing or invalid\n*`BE18`-Contact details missing or invalid\n*`BE19`-Charge bearer code for transaction type is invalid\n*`BE20`-Name length exceeds local rules for payment type.\n*`BE21`-Name missing or invalid.  Generic usage if cannot specifically identify debtor or creditor.\n*`BE22`-Creditor name is missing\n*`BE23`-Phone number or email address, or any other proxy, used as the account proxy is unknown or invalid.\n*`CERI`-Credit transfer is not tagged as an Extended Remittance Information (ERI) transaction but contains ERI.\n*`CH03`-Value in Requested Execution Date or Requested Collection Date is too far in the future\n*`CH04`-Value in Requested Execution Date or Requested Collection Date is too far in the past\n*`CH07`-Element is not to be used at B- and C-Level\n*`CH09`-Mandate changes are not allowed\n*`CH10`-Information on mandate changes are missing\n*`CH11`-Value in Creditor Identifier is incorrect\n*`CH12`-Creditor Identifier is ambiguous at Transaction Level\n*`CH13`-Original Debtor Account is not to be used\n*`CH14`-Original Debtor Agent  is not to be used\n*`CH15`-Content Remittance Information/Structured includes more than 140 characters\n*`CH16`-Content is incorrect\n*`CH17`-Element is not allowed\n*`CH19`-Values in Interbank Settlement Date or Requested Collection Date will be set to the next TARGET day\n*`CH20`-Number of decimal points not compatible with the currency\n*`CH21`-Mandatory element is missing \n*`CH22`-SDD CORE and B2B not permitted within one message \n*`CHQC`-Cheque has been presented in cheque clearing and settled on the creditor’s account.\n*`CNOR`-Creditor bank is not registered under this BIC in the CSM\n*`CURR`-Currency of the payment is incorrect\n*`CUST`-Cancellation requested by the Debtor\n*`DNOR`-Debtor bank is not registered under this BIC in the CSM\n*`DS01`-The electronic signature(s) is/are correct\n*`DS02`-An authorized user has cancelled the order\n*`DS03`-The user’s attempt to cancel the order was not successful \n*`DS04`-The order was rejected by the bank side (for reasons concerning content)\n*`DS05`-The order was correct and could be forwarded for postprocessing\n*`DS06`-The order was transferred to VEU\n*`DS07`-All actions concerning the order could be done by the EBICS bank server\n*`DS08`-The decompression of the file was not successful\n*`DS09`-The decryption of the file was not successful\n*`DS0A`-Data signature is required.\n*`DS0B`-Data signature for the format is not available or invalid.\n*`DS0C`-The signer certificate is revoked.\n*`DS0D`-The signer certificate is not valid (revoked or not active).\n*`DS0E`-The signer certificate is not present.\n*`DS0F`-The authority of the signer certification sending the certificate is unknown.\n*`DS0G`-Signer is not allowed to sign this operation type.\n*`DS0H`-Signer is not allowed to sign for this account.\n*`DS0K`-The number of transaction is over the number allowed for this signer.\n*`DS10`-The certificate is revoked for the first signer.\n*`DS11`-The certificate is not valid (revoked or not active) for the first signer.\n*`DS12`-The certificate is not present for the first signer.\n*`DS13`-The authority of signer certification sending the certificate is unknown for the first signer.\n*`DS14`-The user is unknown on the server\n*`DS15`-The same signature has already been sent to the bank\n*`DS16`-The public key version is not correct. This code is returned when a customer sends signature files to the financial institution after conversion from an older program version (old ES format) to a new program version (new ES format) without having carried out re-initialisation with regard to a public key change.\n*`DS17`-Order data and signatures don’t match\n*`DS18`-File cannot be tested, the complete order has to be repeated. This code is returned in the event of a malfunction during the signature check, e.g. not enough storage space.\n*`DS19`-The user’s rights (concerning his signature) are insufficient to execute the order\n*`DS20`-The certificate is revoked for the second signer.\n*`DS21`-The certificate is not valid (revoked or not active) for the second signer.\n*`DS22`-The certificate is not present for the second signer.\n*`DS23`-The authority of signer certification sending the certificate is unknown for the second signer.\n*`DS24`-Waiting time expired due to incomplete order\n*`DS25`-The order file was deleted by the bank server \n(for multiple reasons)\n*`DS26`-The same user has signed multiple times\n*`DS27`-The user is not yet activated (technically)\n*`DT01`-Invalid date (eg, wrong or missing settlement date)\n*`DT02`-Invalid creation date and time in Group Header (eg, historic date)\n*`DT03`-Invalid non bank processing date (eg, weekend or local public holiday)\n*`DT04`-Future date not supported\n*`DT05`-Associated message, payment information block or transaction was received after agreed processing cut-off date, i.e., date in the past.\n*`DT06`-Execution Date has been modified in order for transaction to be processed\n*`DU01`-Message Identification is not unique.\n*`DU02`-Payment Information Block is not unique.\n*`DU03`-Transaction is not unique.\n*`DU04`-End To End ID is not unique.\n*`DU05`-Instruction ID is not unique.\n*`DUPL`-Payment or charge is a duplicate of another payment or charge.\n*`ED01`-Correspondent bank not possible.\n*`ED03`-Balance of payments complementary info is requested\n*`ED05`-Settlement of the transaction has failed.\n*`ED06`-Interbank settlement system not available.\n*`ERIN`-Extended Remittance Information (ERI) option is not supported.\n*`FF01`-File Format incomplete or invalid\n*`FF02`-Syntax error reason is provided as narrative information in the additional reason information.\n*`FF03`-Payment Type Information is missing or invalid.\nGeneric usage if cannot specify Service Level or Local Instrument code\n*`FF04`-Service Level code is missing or invalid\n*`FF05`-Local Instrument code is missing or invalid\n*`FF06`-Category Purpose code is missing or invalid\n*`FF07`-Purpose is missing or invalid\n*`FF08`-End to End Id missing or invalid\n*`FF09`-Cheque number missing or invalid\n*`FF10`-File or transaction cannot be processed due to technical issues at the bank side\n*`FF11`-Clearing request rejected due it being subject to an abort operation.\n*`G000`-In an FI To FI Customer Credit Transfer: The Status Originator transferred the payment to the next Agent or to a Market Infrastructure. The payment transfer is tracked. No further updates will follow from the Status Originator.\n\nIn a Financial Institution Credit Transfer with cover: The Status Originator performed the account booking and transferred the cover transaction to the next Reimbursement Agent or to a Market Infrastructure. The payment transfer is tracked. No further updates will follow from the Status Originator.\n\n*`G001`-In an FI To FI Customer Credit Transfer: The Status Originator transferred the payment to the next Agent or to a Market Infrastructure. The payment transfer is not tracked. No further updates will follow from the Status Originator.\n\nIn a Financial Institution Credit Transfer with cover: The Status Originator performed the account booking and transferred the cover transaction to the next Reimbursement Agent or to a Market Infrastructure. The payment transfer is not tracked. No further updates will follow from the Status Originator.\n\n*`G002`-In a FIToFI Customer Credit Transfer: Credit to the creditor’s account may not be confirmed same day. Update will follow from the Status Originator.\nIn a Financial Institution Credit Transfer with cover: Debit/credit to nostro account may not be confirmed same day or Financial Institution Credit Transfer may not be transferred same day. Update will follow from the Status Originator.\n*`G003`-In a FIToFI Customer Credit Transfer: Credit to creditor’s account is pending receipt of required documents. The Status Originator has requested creditor to provide additional documentation. Update will follow from the Status Originator. \nIn a Financial Institution Credit Transfer with cover: Status Originator has requested a previous Agent to provide additional information/correct information. Update will follow from the Status Originator.\n*`G004`-In a FIToFI Customer Credit Transfer: Credit to the creditor’s account is pending, status Originator is waiting for funds provided via a cover. Update will follow from the Status Originator.\n*`G005`-Payment has been delivered to creditor agent with service level.\n*`G006`-Payment has been delivered to creditor agent without service level.\n*`ID01`-Signature file was sent to the bank but the corresponding original file has not been sent yet.\n*`MD01`-No Mandate\n*`MD02`-Mandate related information data required by the scheme is missing.\n*`MD05`-Creditor or creditor's agent should not have collected the direct debit\n*`MD06`-Return of funds requested by end customer\n*`MD07`-End customer is deceased.\n*`MS02`-Reason has not been specified by end customer\n*`MS03`-Reason has not been specified by agent.\n*`NARR`-Reason is provided as narrative information in the additional reason information.\n*`NERI`-Credit transfer is tagged as an Extended Remittance Information (ERI) transaction but does not contain ERI.\n*`RC01`-Bank identifier code specified in the message has an incorrect format (formerly IncorrectFormatForRoutingCode).\n*`RC02`-Bank identifier is invalid or missing.\nGeneric usage if cannot specify between debit or credit account\n*`RC03`-Debtor bank identifier is invalid or missing\n*`RC04`-Creditor bank identifier is invalid or missing\n*`RC05`-BIC identifier is invalid or missing.\nGeneric usage if cannot specify between debit or credit account.\n*`RC06`-Debtor BIC identifier is invalid or missing\n*`RC07`-Creditor BIC identifier is invalid or missing\n*`RC08`-ClearingSystemMemberidentifier is invalid or missing.\nGeneric usage if cannot specify between debit or credit account\n*`RC09`-Debtor ClearingSystemMember identifier is invalid or missing\n*`RC10`-Creditor ClearingSystemMember identifier is invalid or missing\n*`RC11`-Intermediary Agent is invalid or missing\n*`RC12`-Creditor Scheme Id is invalid or  missing\n*`RCON`-Conflict with R-Message\n*`RECI`-Further information regarding the intended recipient. \n*`RF01`-Transaction reference is not unique within the message.\n*`RR01`-Specification of the debtor’s account or unique identification needed for reasons of regulatory requirements is insufficient or missing\n*`RR02`-Specification of the debtor’s name and/or address needed for regulatory requirements is insufficient or missing.\n*`RR03`-Specification of the creditor’s name and/or address needed for regulatory requirements is insufficient or missing.\n*`RR04`-Regulatory Reason\n*`RR05`-Regulatory or Central Bank Reporting information missing, incomplete or invalid.\n*`RR06`-Tax information missing, incomplete or invalid.\n*`RR07`-Remittance information structure does not comply with rules for payment type.\n*`RR08`-Remittance information truncated to comply with rules for payment type.\n*`RR09`-Structured creditor reference invalid or missing.\n*`RR10`-Character set supplied not valid for the country and payment type.\n*`RR11`-Invalid or missing identification of a bank proprietary service.\n*`RR12`-Invalid or missing identification required within a particular country or payment type.\n*`S000`-Request for Cancellation is acknowledged following validation.\n*`S001`-Unique End-to-end Transaction Reference (UETR) relating to a payment has been identified as being associated with a Request for Cancellation.\n*`S002`-Unique End-to-end Transaction Reference (UETR) relating to a payment has been prevent from traveling across a messaging network.\n*`S003`-Request for Cancellation has been forwarded to the payment processing/last payment processing agent.\n*`S004`-Request for Cancellation has been acknowledged as delivered to payment processing/last payment processing agent.\n*`SL01`-Due to specific service offered by the Debtor Agent.\n*`SL02`-Due to specific service offered by the Creditor Agent.\n*`SL03`-Due to a specific service offered by the clearing system.\n*`SL11`-Whitelisting service offered by the Debtor Agent; Debtor has not included the Creditor on its “Whitelist” (yet). In the Whitelist the Debtor may list all allowed Creditors to debit Debtor bank account.\n*`SL12`-Blacklisting service offered by the Debtor Agent; Debtor included the Creditor on his “Blacklist”. In the Blacklist the Debtor may list all Creditors not allowed to debit Debtor bank account.\n*`SL13`-Due to Maximum allowed Direct Debit Transactions per period service offered by the Debtor Agent.\n*`SL14`-Due to Maximum allowed Direct Debit Transaction amount service offered by the Debtor Agent.\n*`TA01`-The transmission of the file was not successful – it had to be aborted (for technical reasons)\n*`TD01`-There is no data available (for download)\n*`TD02`-The file cannot be read (e.g. unknown format)\n*`TD03`-The file format is incomplete or invalid\n*`TK01`-Token is invalid.\n*`TK02`-Token used for the sender does not exist.\n*`TK03`-Token used for the receiver does not exist.\n*`TK09`-Token required for request is missing.\n*`TKCM`-Token found with counterparty mismatch. \n*`TKSG`-Single Use Token already used. \n*`TKSP`-Token found with suspended status.\n*`TKVE`-Token found with value limit rule violation. \n*`TKXP`-Token expired.\n*`TM01`-Associated message, payment information block, or transaction was received after agreed processing cut-off time.\n*`TS01`-The (technical) transmission of the file was successful.\n*`TS04`-The order was transferred to pass by accompanying note signed by hand\n*`CN01`-Authorisation is cancelled.\n*`FOCR`-Return following a cancellation request.\n*`FR01`-Returned as a result of fraud.\n*`NOAS`-No response from Beneficiary.\n*`NOCM`-Customer account is not compliant with regulatory requirements, for example FICA (in South Africa) or any other regulatory requirements which render an account inactive for certain processing.\n*`RUTA`-Return following investigation request and no remediation possible.\n*`UPAY`-Payment is not justified.\n*`AEXR`-Request-to-pay Expiry Date and Time has already passed.\n*`ALAC`-Request-to-pay has already been accepted by the Debtor.\n*`ARFR`-Request-to-pay has already been refused by the Debtor.\n*`ARJR`-Request-to-pay has already been rejected.\n*`ATNS`-Attachments to the request-to-pay are not supported.\n*`EDTL`-Expiry date time of the request-to-pay is too far in the future.\n*`EDTR`-Expiry date time of the request-to-pay is already reached.\n*`FRAD`-Cancellation requested following a transaction that was originated fraudulently. The use of the FraudulentOrigin code should be governed by jurisdictions.\n*`IEDT`-Expiry date time of the request-to-pay is incorrect.\n*`IRNR`-No initial request-to-pay has been received.\n*`NOAR`-No existing agreement for receiving request-to-pay messages.\n*`NOPG`-Requested payment guarantee (by Creditor) related to a request-to-pay cannot be provided.\n*`NRCH`-Recipient side of the request-to-pay (payer or its request-to-pay service provider) is not reachable.\n*`PINS`-Type of payment requested in the request-to-pay is not supported by the payer.\n*`REPR`-Request-to-pay has been received and can be processed further.\n*`RTNS`-Debtor does not support request-to-pay transactions.\n*`SPII`-Identifier of the request-to-pay service provider is incorrect.\n*`UCRD`-Unknown Creditor.\n*`FF12`-Original payment is not eligible to be returned given its current status.\n*`FF13`-No record of request for cancellation found.\n*`DC02`-Rejection of a payment due to covering FI settlement not being received.\n*`APAR`-Request To Pay has already been paid by the Debtor.\n*`AB26`-Settlement Instruction does not exist.\n*`AB12`-Duplicate Concurrent Batch Sequence number– for Settlement Instructions.\n*`AB13`-Wrong Message Routing Type for Return-of-Funds.\n*`AB15`-Instruction may not be placed on the Continuous Processing Line settlement processor.\n*`AB21`-Agreement number not valid (beneficiary).\n*`BDAY`-Settlement Cycle Day and Calendar day should be the same.\n*`DS28`-Message routed to the wrong environment.\n*`INDT`-Details not valid for this field.\n*`ISWS`-Cannot schedule instruction for Night Window.\n*`MINF`-Information missing for the field or cannot be empty.\n*`NOFR`-Continuous Processing Line on Hold Instruction.\n*`RC13`-Originator not active any more.\n*`RC15`-Settlement agreement required.\n*`RC16`-Participant blocked from SADC-RTGS.\n*`SBRN`-Remove Concurrent Batch Processing Line on hold instruction.\n*`RQNR`-Payer did not recognize the request from Payee Participant,\n*`SNRD`-Services are not yet rendered by the Payee Participant (Creditor).\n*`OSNS`-Requested optional service (for example instalment payments) is not supported.\n*`AMSE`-Size of the attachment exceeds the allowed maximum.\n*`INAR`-Payer’s activation reference is invalid.\n*`EDNA`-Requested execution date of the payment is not accepted.\n*`SL15`-Maximum number of credit transactions allowed by the account servicer per service period exceeded.\n*`SL16`-Maximum total credit amount allowed by the account servicer per service period exceeded.\n*`SL17`-Whitelisting service offered by payment system operator or financial institution. Debtor is not included on the Creditor side whitelist.\n*`SL18`-Blacklisting service offered by payment system operator or financial institution. Debtor included on the Creditor side blacklist.\n*`CHRG`-Related to a Charge message to convey that the charge bearer code used in the corresponding Payment message was not debt.\n*`CHCO`-Related to a Charge message to convey that the code in Charge Breakdown / Type / Code is not accepted by the receiving party.\n*`IPNS`-Payments in instalments are not supported.\n*`CNNS`-Credit notes are not supported.\n*`EOL1`-Expiration of the payment authorisation due to no use for too long."
      enum:
        - AB01
        - AB02
        - AB03
        - AB04
        - AB05
        - AB06
        - AB07
        - AB08
        - AB09
        - AB10
        - AB11
        - AC01
        - AC02
        - AC03
        - AC04
        - AC05
        - AC06
        - AC07
        - AC08
        - AC09
        - AC10
        - AC11
        - AC12
        - AC13
        - AC14
        - AC15
        - AC16
        - AG01
        - AG02
        - AG03
        - AG04
        - AG05
        - AG06
        - AG07
        - AG08
        - AG09
        - AG10
        - AG11
        - AG12
        - AG13
        - AGNT
        - AM01
        - AM02
        - AM03
        - AM04
        - AM05
        - AM06
        - AM07
        - AM09
        - AM10
        - AM11
        - AM12
        - AM13
        - AM14
        - AM15
        - AM16
        - AM17
        - AM18
        - AM19
        - AM20
        - AM21
        - AM22
        - AM23
        - BE01
        - BE04
        - BE05
        - BE06
        - BE07
        - BE08
        - BE09
        - BE10
        - BE11
        - BE12
        - BE13
        - BE14
        - BE15
        - BE16
        - BE17
        - BE18
        - BE19
        - BE20
        - BE21
        - BE22
        - BE23
        - CERI
        - CH03
        - CH04
        - CH07
        - CH09
        - CH10
        - CH11
        - CH12
        - CH13
        - CH14
        - CH15
        - CH16
        - CH17
        - CH19
        - CH20
        - CH21
        - CH22
        - CHQC
        - CNOR
        - CURR
        - CUST
        - DNOR
        - DS01
        - DS02
        - DS03
        - DS04
        - DS05
        - DS06
        - DS07
        - DS08
        - DS09
        - DS0A
        - DS0B
        - DS0C
        - DS0D
        - DS0E
        - DS0F
        - DS0G
        - DS0H
        - DS0K
        - DS10
        - DS11
        - DS12
        - DS13
        - DS14
        - DS15
        - DS16
        - DS17
        - DS18
        - DS19
        - DS20
        - DS21
        - DS22
        - DS23
        - DS24
        - DS25
        - DS26
        - DS27
        - DT01
        - DT02
        - DT03
        - DT04
        - DT05
        - DT06
        - DU01
        - DU02
        - DU03
        - DU04
        - DU05
        - DUPL
        - ED01
        - ED03
        - ED05
        - ED06
        - ERIN
        - FF01
        - FF02
        - FF03
        - FF04
        - FF05
        - FF06
        - FF07
        - FF08
        - FF09
        - FF10
        - FF11
        - G000
        - G001
        - G002
        - G003
        - G004
        - G005
        - G006
        - ID01
        - MD01
        - MD02
        - MD05
        - MD06
        - MD07
        - MS02
        - MS03
        - NARR
        - NERI
        - RC01
        - RC02
        - RC03
        - RC04
        - RC05
        - RC06
        - RC07
        - RC08
        - RC09
        - RC10
        - RC11
        - RC12
        - RCON
        - RECI
        - RF01
        - RR01
        - RR02
        - RR03
        - RR04
        - RR05
        - RR06
        - RR07
        - RR08
        - RR09
        - RR10
        - RR11
        - RR12
        - S000
        - S001
        - S002
        - S003
        - S004
        - SL01
        - SL02
        - SL03
        - SL11
        - SL12
        - SL13
        - SL14
        - TA01
        - TD01
        - TD02
        - TD03
        - TK01
        - TK02
        - TK03
        - TK09
        - TKCM
        - TKSG
        - TKSP
        - TKVE
        - TKXP
        - TM01
        - TS01
        - TS04
        - CN01
        - FOCR
        - FR01
        - NOAS
        - NOCM
        - RUTA
        - UPAY
        - AEXR
        - ALAC
        - ARFR
        - ARJR
        - ATNS
        - EDTL
        - EDTR
        - FRAD
        - IEDT
        - IRNR
        - NOAR
        - NOPG
        - NRCH
        - PINS
        - REPR
        - RTNS
        - SPII
        - UCRD
        - FF12
        - FF13
        - DC02
        - APAR
        - AB26
        - AB12
        - AB13
        - AB15
        - AB21
        - BDAY
        - DS28
        - INDT
        - ISWS
        - MINF
        - NOFR
        - RC13
        - RC15
        - RC16
        - SBRN
        - RQNR
        - SNRD
        - OSNS
        - AMSE
        - INAR
        - EDNA
        - SL15
        - SL16
        - SL17
        - SL18
        - CHRG
        - CHCO
        - IPNS
        - CNNS
        - EOL1
    ExternalTaxAmountType1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the nature, or use, of the amount in the format of character string with a maximum length of 4 characters.\r\nThe list of valid codes is an external code list published separately.\r\nExternal code sets can be downloaded from www.iso20022.org.\n*`CITY`-Tax accessed by city jurisdications within a country.\n*`CNTY`-Tax accessed by county jurisdications within a country.\n*`LOCL`-Tax accessed by local jurisdications within a country.\n*`PROV`-Tax accessed by province jurisdications within a country.\n*`STAT`-Tax accessed by state jurisdications within a country."
      enum:
        - CITY
        - CNTY
        - LOCL
        - PROV
        - STAT
    FinancialIdentificationSchemeName1Choice:
      type: object
      description: >-
        Sets of elements to identify a name of the organisation identification
        scheme.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Name of the identification scheme, in a coded form as published
                in an external list.
              $ref: >-
                #/components/schemas/ExternalFinancialInstitutionIdentification1Code
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Name of the identification scheme, in a free text form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    FinancialInstitutionIdentification18:
      type: object
      description: Specifies the details to identify a financial institution.
      additionalProperties: false
      properties:
        bicfi:
          description: >-
            Code allocated to a financial institution by the ISO 9362
            Registration Authority as described in ISO 9362 "Banking - Banking
            telecommunication messages - Business identifier code (BIC)".
          $ref: '#/components/schemas/BICFIDec2014Identifier'
        clearing_system_member_identification:
          description: Information used to identify a member within a clearing system.
          $ref: '#/components/schemas/ClearingSystemMemberIdentification2'
        lei:
          description: Legal entity identifier of the financial institution.
          $ref: '#/components/schemas/LEIIdentifier'
        name:
          description: >-
            Name by which an agent is known and which is usually used to
            identify that agent.
          $ref: '#/components/schemas/Max140Text'
        postal_address:
          description: >-
            Information that locates and identifies a specific address, as
            defined by postal services.
          $ref: '#/components/schemas/PostalAddress24'
        other:
          description: >-
            Unique identification of an agent, as assigned by an institution,
            using an identification scheme.
          $ref: '#/components/schemas/GenericFinancialIdentification1'
    Frequency36Choice:
      type: object
      description: Choice of format for a frequency, for example, the frequency of payment.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            type:
              description: Specifies a frequency in terms of a specified period type.
              $ref: '#/components/schemas/Frequency6Code'
          required:
            - type
        - type: object
          additionalProperties: false
          properties:
            period:
              description: >-
                Specifies a frequency in terms of a count per period within a
                specified period type.
              $ref: '#/components/schemas/FrequencyPeriod1'
          required:
            - period
        - type: object
          additionalProperties: false
          properties:
            point_in_time:
              description: >-
                Specifies a frequency in terms of an exact point in time or
                moment within a specified period type.
              $ref: '#/components/schemas/FrequencyAndMoment1'
          required:
            - point_in_time
    Frequency6Code:
      type: string
      description: |-
        Specifies the regularity of an event.
        *`YEAR`-Event takes place every year or once a year.
        *`MNTH`-Event takes place every month or once a month.
        *`QURT`-Event takes place every three months or four times a year.
        *`MIAN`-Event takes place every six months or two times a year.
        *`WEEK`-Event takes place once a week.
        *`DAIL`-Event takes place every day.
        *`ADHO`-Event takes place on request or as necessary.
        *`INDA`-Event takes place several times a day.
        *`FRTN`-Event takes place every two weeks.
      enum:
        - YEAR
        - MNTH
        - QURT
        - MIAN
        - WEEK
        - DAIL
        - ADHO
        - INDA
        - FRTN
    FrequencyAndMoment1:
      type: object
      description: >-
        Defines a frequency in terms a specific moment within a specified period
        type.
      additionalProperties: false
      properties:
        type:
          description: >-
            Period for which the number of instructions are to be created and
            processed.
          $ref: '#/components/schemas/Frequency6Code'
        point_in_time:
          description: >-
            Further information on the exact point in time the event should take
            place.
          $ref: '#/components/schemas/Exact2NumericText'
      required:
        - type
        - point_in_time
    FrequencyPeriod1:
      type: object
      description: >-
        Defines a frequency in terms on counts per period for a specific period
        type.
      additionalProperties: false
      properties:
        type:
          description: >-
            Period for which the number of instructions are to be created and
            processed.
          $ref: '#/components/schemas/Frequency6Code'
        count_per_period:
          description: >-
            Number of instructions to be created and processed during the
            specified period.
          $ref: '#/components/schemas/DecimalNumber'
      required:
        - type
        - count_per_period
    Garnishment3:
      type: object
      description: >-
        Provides remittance information about a payment for garnishment-related
        purposes.
      additionalProperties: false
      properties:
        type:
          description: Specifies the type of garnishment.
          $ref: '#/components/schemas/GarnishmentType1'
        garnishee:
          description: >-
            Ultimate party that owes an amount of money to the (ultimate)
            creditor, in this case, to the garnisher.
          $ref: '#/components/schemas/PartyIdentification135'
        garnishment_administrator:
          description: >-
            Party on the credit side of the transaction who administers the
            garnishment on behalf of the ultimate beneficiary.
          $ref: '#/components/schemas/PartyIdentification135'
        reference_number:
          description: >-
            Reference information that is specific to the agency receiving the
            garnishment.
          $ref: '#/components/schemas/Max140Text'
        date:
          description: Date of payment which garnishment was taken from.
          $ref: '#/components/schemas/ISODate'
        remitted_amount:
          description: Amount of money remitted for the referred document.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        family_medical_insurance_indicator:
          description: >-
            Indicates if the person to whom the garnishment applies (that is,
            the ultimate debtor) has family medical insurance coverage
            available.
          $ref: '#/components/schemas/TrueFalseIndicator'
        employee_termination_indicator:
          description: >-
            Indicates if the employment of the person to whom the garnishment
            applies (that is, the ultimate debtor) has been terminated.
          $ref: '#/components/schemas/TrueFalseIndicator'
      required:
        - type
    GarnishmentType1:
      type: object
      description: Specifies the type of garnishment.
      additionalProperties: false
      properties:
        code_or_proprietary:
          description: Provides the type details of the garnishment.
          $ref: '#/components/schemas/GarnishmentType1Choice'
        issuer:
          description: Identification of the issuer of the garnishment type.
          $ref: '#/components/schemas/Max35Text'
      required:
        - code_or_proprietary
    GarnishmentType1Choice:
      type: object
      description: Specifies the type of garnishment.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: "Garnishment type in a coded form. Would suggest this to be an External Code List to contain: GNCS\_\_\_ Garnishment from a third party payer for Child Support GNDP\_\_\_ Garnishment from a Direct Payer for Child Support GTPP\_\_\_\_ Garnishment from a third party payer to taxing agency."
              $ref: '#/components/schemas/ExternalGarnishmentType1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Proprietary identification of the type of garnishment.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    GenericAccountIdentification1:
      type: object
      description: Information related to a generic account identification.
      additionalProperties: false
      properties:
        identification:
          description: Identification assigned by an institution.
          $ref: '#/components/schemas/Max34Text'
        scheme_name:
          description: Name of the identification scheme.
          $ref: '#/components/schemas/AccountSchemeName1Choice'
        issuer:
          description: Entity that assigns the identification.
          $ref: '#/components/schemas/Max35Text'
      required:
        - identification
    GenericFinancialIdentification1:
      type: object
      description: Information related to an identification of a financial institution.
      additionalProperties: false
      properties:
        identification:
          description: Unique and unambiguous identification of a person.
          $ref: '#/components/schemas/Max35Text'
        scheme_name:
          description: Name of the identification scheme.
          $ref: '#/components/schemas/FinancialIdentificationSchemeName1Choice'
        issuer:
          description: Entity that assigns the identification.
          $ref: '#/components/schemas/Max35Text'
      required:
        - identification
    GenericIdentification30:
      type: object
      description: >-
        Information related to an identification, for example, party
        identification or account identification.
      additionalProperties: false
      properties:
        identification:
          description: >-
            Proprietary information, often a code, issued by the data source
            scheme issuer.
          $ref: '#/components/schemas/Exact4AlphaNumericText'
        issuer:
          description: Entity that assigns the identification.
          $ref: '#/components/schemas/Max35Text'
        scheme_name:
          description: Short textual description of the scheme.
          $ref: '#/components/schemas/Max35Text'
      required:
        - identification
        - issuer
    GenericOrganisationIdentification1:
      type: object
      description: Information related to an identification of an organisation.
      additionalProperties: false
      properties:
        identification:
          description: Identification assigned by an institution.
          $ref: '#/components/schemas/Max35Text'
        scheme_name:
          description: Name of the identification scheme.
          $ref: '#/components/schemas/OrganisationIdentificationSchemeName1Choice'
        issuer:
          description: Entity that assigns the identification.
          $ref: '#/components/schemas/Max35Text'
      required:
        - identification
    GenericPersonIdentification1:
      type: object
      description: Information related to an identification of a person.
      additionalProperties: false
      properties:
        identification:
          description: Unique and unambiguous identification of a person.
          $ref: '#/components/schemas/Max35Text'
        scheme_name:
          description: Name of the identification scheme.
          $ref: '#/components/schemas/PersonIdentificationSchemeName1Choice'
        issuer:
          description: Entity that assigns the identification.
          $ref: '#/components/schemas/Max35Text'
      required:
        - identification
    GroupHeader86:
      type: object
      description: >-
        Provides the characteristics shared by all individual transactions
        included in the message.
      additionalProperties: false
      properties:
        message_identification:
          description: >-
            Point to point reference, as assigned by the instructing party, and
            sent to the next party in the chain to unambiguously identify the
            message. Usage: The instructing party has to make sure that
            'MessageIdentification' is unique per instructed party for a
            pre-agreed period.
          $ref: '#/components/schemas/Max35Text'
        creation_date_time:
          description: Date and time at which the message was created.
          $ref: '#/components/schemas/ISODateTime'
        initiating_party:
          description: Party that initiates the status message.
          $ref: '#/components/schemas/PartyIdentification135'
        forwarding_agent:
          description: >-
            Financial institution that receives the instruction from the
            initiating party and forwards it to the next agent in the payment
            chain.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        debtor_agent:
          description: Financial institution servicing an account for the debtor.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        creditor_agent:
          description: Financial institution servicing an account for the creditor.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
      required:
        - message_identification
        - creation_date_time
    IBAN2007Identifier:
      type: string
      description: >-
        The International Bank Account Number is a code used internationally by
        financial institutions to uniquely identify the account of a customer at
        a financial institution as described in the 2007 edition of the ISO
        13616 standard "Banking and related financial services - International
        Bank Account Number (IBAN)" and replaced by the more recent edition of
        the standard.
      pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
    ISODate:
      type: string
      description: >-
        A particular point in the progression of time in a calendar year
        expressed in the YYYY-MM-DD format. This representation is defined in
        "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28
        October 2004" which is aligned with ISO 8601.
      pattern: >-
        ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)(?:Z|[+-][01]\d:[0-5]\d)?$
    ISOYear:
      type: string
      description: Year represented by YYYY (ISO 8601).
      pattern: ^[1-9]\d{3}$
    LEIIdentifier:
      type: string
      description: >-
        Legal Entity Identifier is a code allocated to a party as described in
        ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
      pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$
    LocalInstrument2Choice:
      type: object
      description: >-
        Set of elements that further identifies the type of local instruments
        being requested by the initiating party.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Specifies the local instrument, as published in an external
                local instrument code list.
              $ref: '#/components/schemas/ExternalLocalInstrument1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Specifies the local instrument, as a proprietary code.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    MandateClassification1Choice:
      type: object
      description: >-
        Specifies the high level purpose of the instruction based on a set of
        pre-defined categories.

        Usage: This is used by the initiating party to provide information
        concerning the processing of the payment. It is likely to trigger
        special processing by any of the agents involved in the payment chain.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Category purpose, as published in an external category purpose
                code list.
              $ref: '#/components/schemas/MandateClassification1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Category purpose, in a proprietary form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    MandateClassification1Code:
      type: string
      description: |-
        Specifies the type of direct debit amount, such as fixed or variable.
        *`FIXE`-Direct debit amount is fixed.
        *`USGB`-Direct debit amount is based on usage.
        *`VARI`-Direct debit amount is variable.
      enum:
        - FIXE
        - USGB
        - VARI
    MandateRelatedData2Choice:
      type: object
      description: Choice of mandate related information.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            direct_debit_mandate:
              description: Specific direct debit mandate data.
              $ref: '#/components/schemas/MandateRelatedInformation15'
        - type: object
          additionalProperties: false
          properties:
            credit_transfer_mandate:
              description: Specific credit transfer mandate data.
              $ref: '#/components/schemas/CreditTransferMandateData1'
    MandateRelatedInformation15:
      type: object
      description: >-
        Provides further details related to a direct debit mandate signed
        between the creditor and the debtor.
      additionalProperties: false
      properties:
        mandate_identification:
          description: >-
            Unique identification, as assigned by the creditor, to unambiguously
            identify the mandate.
          $ref: '#/components/schemas/Max35Text'
        date_of_signature:
          description: >-
            Date on which the direct debit mandate has been signed by the
            debtor.
          $ref: '#/components/schemas/ISODate'
        amendment_indicator:
          description: >-
            Indicator notifying whether the underlying mandate is amended or
            not.
          $ref: '#/components/schemas/TrueFalseIndicator'
        amendment_information_details:
          description: List of mandate elements that have been modified.
          $ref: '#/components/schemas/AmendmentInformationDetails14'
        electronic_signature:
          description: >-
            Additional security provisions, such as a digital signature, as
            provided by the debtor.
          $ref: '#/components/schemas/Max1025Text'
        first_collection_date:
          description: Date of the first collection of a direct debit as per the mandate.
          $ref: '#/components/schemas/ISODate'
        final_collection_date:
          description: Date of the final collection of a direct debit as per the mandate.
          $ref: '#/components/schemas/ISODate'
        frequency:
          description: >-
            Regularity with which direct debit instructions are to be created
            and processed.
          $ref: '#/components/schemas/Frequency36Choice'
        reason:
          description: >-
            Reason for the direct debit mandate to allow the user to distinguish
            between different mandates for the same creditor.
          $ref: '#/components/schemas/MandateSetupReason1Choice'
        tracking_days:
          description: >-
            Specifies the number of days the direct debit instruction must be
            tracked.
          $ref: '#/components/schemas/Exact2NumericText'
    MandateSetupReason1Choice:
      type: object
      description: Specifies the reason for the setup of the mandate.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Reason for the mandate setup, as published in an external reason
                code list.
              $ref: '#/components/schemas/ExternalMandateSetupReason1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Reason for the mandate setup, in a proprietary form.
              $ref: '#/components/schemas/Max70Text'
          required:
            - proprietary
    MandateTypeInformation2:
      type: object
      description: >-
        Set of elements used to further detail the information related to the
        type of payment.
      additionalProperties: false
      properties:
        service_level:
          description: Agreement under which or rules under which the mandate resides.
          $ref: '#/components/schemas/ServiceLevel8Choice'
        local_instrument:
          description: >-
            User community specific instrument. Usage: This element is used to
            specify a local instrument, local clearing option and/or further
            qualify the service or service level.
          $ref: '#/components/schemas/LocalInstrument2Choice'
        category_purpose:
          description: >-
            Specifies the high level purpose of the mandate based on a set of
            pre-defined categories.
          $ref: '#/components/schemas/CategoryPurpose1Choice'
        classification:
          description: Type of direct debit instruction.
          $ref: '#/components/schemas/MandateClassification1Choice'
    Max1025Text:
      type: string
      description: Specifies a character string with a maximum length of 1025 characters.
      minLength: 1
      maxLength: 1025
    Max105Text:
      type: string
      description: Specifies a character string with a maximum length of 105 characters.
      minLength: 1
      maxLength: 105
    Max10KBinary:
      type: string
      format: byte
      description: Binary data of 10K maximum.
      minLength: 1
      maxLength: 10240
    Max128Text:
      type: string
      description: Specifies a character string with a maximum length of 128 characters.
      minLength: 1
      maxLength: 128
    Max140Text:
      type: string
      description: Specifies a character string with a maximum length of 140 characters.
      minLength: 1
      maxLength: 140
    Max15NumericText:
      type: string
      description: Specifies a numeric string with a maximum length of 15 digits.
      pattern: ^[0-9]{1,15}$
    Max16Text:
      type: string
      description: Specifies a character string with a maximum length of 16 characters.
      minLength: 1
      maxLength: 16
    Max2048Text:
      type: string
      description: Specifies a character string with a maximum length of 2048 characters.
      minLength: 1
      maxLength: 2048
    Max34Text:
      type: string
      description: Specifies a character string with a maximum length of 34 characters.
      minLength: 1
      maxLength: 34
    Max350Text:
      type: string
      description: Specifies a character string with a maximum length of 350 characters.
      minLength: 1
      maxLength: 350
    Max35Text:
      type: string
      description: Specifies a character string with a maximum length of 35 characters.
      minLength: 1
      maxLength: 35
    Max4Text:
      type: string
      description: Specifies a character string with a maximum length of 4 characters.
      minLength: 1
      maxLength: 4
    Max70Text:
      type: string
      description: Specifies a character string with a maximum length of 70characters.
      minLength: 1
      maxLength: 70
    NamePrefix2Code:
      type: string
      description: |-
        Specifies the terms used to formally address a person.
        *`DOCT`-Title of the person is Doctor or Dr.
        *`MADM`-Title of the person is Madam.
        *`MISS`-Title of the person is Miss.
        *`MIST`-Title of the person is Mister or Mr.
        *`MIKS`-Title of the person is gender neutral (Mx).
      enum:
        - DOCT
        - MADM
        - MISS
        - MIST
        - MIKS
    Number:
      type: string
      description: Number of objects represented as an integer.
      maxLength: 19
    NumberOfTransactionsPerStatus5:
      type: object
      description: >-
        Set of elements used to provide detailed information on the number of
        transactions that are reported with a specific transaction status.
      additionalProperties: false
      properties:
        detailed_number_of_transactions:
          description: >-
            Number of individual transactions contained in the message, detailed
            per status.
          $ref: '#/components/schemas/Max15NumericText'
        detailed_status:
          description: Common transaction status for all individual transactions reported.
          $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code'
        detailed_control_sum:
          description: >-
            Total of all individual amounts included in the message,
            irrespective of currencies, detailed per status.
          $ref: '#/components/schemas/DecimalNumber'
      required:
        - detailed_number_of_transactions
        - detailed_status
    OrganisationIdentification29:
      type: object
      description: Unique and unambiguous way to identify an organisation.
      additionalProperties: false
      properties:
        any_bic:
          description: Business identification code of the organisation.
          $ref: '#/components/schemas/AnyBICDec2014Identifier'
        lei:
          description: >-
            Legal entity identification as an alternate identification for a
            party.
          $ref: '#/components/schemas/LEIIdentifier'
        other:
          type: array
          description: >-
            Unique identification of an organisation, as assigned by an
            institution, using an identification scheme.
          items:
            $ref: '#/components/schemas/GenericOrganisationIdentification1'
    OrganisationIdentificationSchemeName1Choice:
      type: object
      description: >-
        Sets of elements to identify a name of the organisation identification
        scheme.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Name of the identification scheme, in a coded form as published
                in an external list.
              $ref: '#/components/schemas/ExternalOrganisationIdentification1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Name of the identification scheme, in a free text form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    OriginalGroupHeader17:
      type: object
      description: Provides details on the original group, to which the message refers.
      additionalProperties: false
      properties:
        original_message_identification:
          description: >-
            Point to point reference, as assigned by the original instructing
            party, to unambiguously identify the original message.
          $ref: '#/components/schemas/Max35Text'
        original_message_name_identification:
          description: >-
            Specifies the original message name identifier to which the message
            refers.
          $ref: '#/components/schemas/Max35Text'
        original_creation_date_time:
          description: Date and time at which the original message was created.
          $ref: '#/components/schemas/ISODateTime'
        original_number_of_transactions:
          description: Number of individual transactions contained in the original message.
          $ref: '#/components/schemas/Max15NumericText'
        original_control_sum:
          description: >-
            Total of all individual amounts included in the original message,
            irrespective of currencies.
          $ref: '#/components/schemas/DecimalNumber'
        group_status:
          description: Specifies the status of a group of transactions.
          $ref: '#/components/schemas/ExternalPaymentGroupStatus1Code'
        status_reason_information:
          type: array
          description: Provides detailed information on the status reason.
          items:
            $ref: '#/components/schemas/StatusReasonInformation12'
        number_of_transactions_per_status:
          type: array
          description: >-
            Detailed information on the number of transactions for each
            identical transaction status.
          items:
            $ref: '#/components/schemas/NumberOfTransactionsPerStatus5'
      required:
        - original_message_identification
        - original_message_name_identification
    OriginalPaymentInstruction40:
      type: object
      description: >-
        Provides detailed information on the original transaction, to which the
        status report message refers.
      additionalProperties: false
      properties:
        original_payment_information_identification:
          description: >-
            Unique identification, as assigned by the original sending party, to
            unambiguously identify the original payment information group.
          $ref: '#/components/schemas/Max35Text'
        original_number_of_transactions:
          description: >-
            Number of individual transactions contained in the original payment
            information group.
          $ref: '#/components/schemas/Max15NumericText'
        original_control_sum:
          description: >-
            Total of all individual amounts included in the original payment
            information group, irrespective of currencies.
          $ref: '#/components/schemas/DecimalNumber'
        payment_information_status:
          description: Specifies the status of the payment information group.
          $ref: '#/components/schemas/ExternalPaymentGroupStatus1Code'
        status_reason_information:
          type: array
          description: Provides detailed information on the status reason.
          items:
            $ref: '#/components/schemas/StatusReasonInformation12'
        number_of_transactions_per_status:
          type: array
          description: >-
            Detailed information on the number of transactions for each
            identical transaction status.
          items:
            $ref: '#/components/schemas/NumberOfTransactionsPerStatus5'
        transaction_information_and_status:
          type: array
          description: >-
            Provides information on the original transactions to which the
            status report message refers.
          items:
            $ref: '#/components/schemas/PaymentTransaction129'
      required:
        - original_payment_information_identification
    OriginalTransactionReference35:
      type: object
      description: Specifies key elements as defined in the original transaction.
      additionalProperties: false
      properties:
        interbank_settlement_amount:
          description: >-
            Amount of money moved between the instructing agent and the
            instructed agent.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        amount:
          description: >-
            Amount of money to be moved between the debtor and creditor, before
            deduction of charges, expressed in the currency as ordered by the
            initiating party.
          $ref: '#/components/schemas/AmountType4Choice'
        interbank_settlement_date:
          description: >-
            Date on which the amount of money ceases to be available to the
            agent that owes it and when the amount of money becomes available to
            the agent to which it is due.
          $ref: '#/components/schemas/ISODate'
        requested_collection_date:
          description: >-
            Date and time at which the creditor requests that the amount of
            money is to be collected from the debtor.
          $ref: '#/components/schemas/ISODate'
        requested_execution_date:
          description: >-
            Date at which the initiating party requests the clearing agent to
            process the payment.  Usage: This is the date on which the debtor's
            account is to be debited. If payment by cheque, the date when the
            cheque must be generated by the bank.
          $ref: '#/components/schemas/DateAndDateTime2Choice'
        creditor_scheme_identification:
          description: Credit party that signs the mandate.
          $ref: '#/components/schemas/PartyIdentification135'
        settlement_information:
          description: >-
            Specifies the details on how the settlement of the original
            transaction(s) between the instructing agent and the instructed
            agent was completed.
          $ref: '#/components/schemas/SettlementInstruction11'
        payment_type_information:
          description: Set of elements used to further specify the type of transaction.
          $ref: '#/components/schemas/PaymentTypeInformation27'
        payment_method:
          description: >-
            Specifies the means of payment that will be used to move the amount
            of money.
          $ref: '#/components/schemas/PaymentMethod4Code'
        mandate_related_information:
          description: >-
            Provides further details of the mandate signed between the creditor
            and the debtor.
          $ref: '#/components/schemas/MandateRelatedData2Choice'
        remittance_information:
          description: >-
            Information supplied to enable the matching of an entry with the
            items that the transfer is intended to settle, such as commercial
            invoices in an accounts' receivable system.
          $ref: '#/components/schemas/RemittanceInformation21'
        ultimate_debtor:
          description: >-
            Ultimate party that owes an amount of money to the (ultimate)
            creditor.
          $ref: '#/components/schemas/Party40Choice'
        debtor:
          description: Party that owes an amount of money to the (ultimate) creditor.
          $ref: '#/components/schemas/Party40Choice'
        debtor_account:
          description: >-
            Unambiguous identification of the account of the debtor to which a
            debit entry will be made as a result of the transaction.
          $ref: '#/components/schemas/CashAccount40'
        debtor_agent:
          description: Financial institution servicing an account for the debtor.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        debtor_agent_account:
          description: >-
            Unambiguous identification of the account of the debtor agent at its
            servicing agent in the payment chain.
          $ref: '#/components/schemas/CashAccount40'
        creditor_agent:
          description: Financial institution servicing an account for the creditor.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        creditor_agent_account:
          description: >-
            Unambiguous identification of the account of the creditor agent at
            its servicing agent to which a credit entry will be made as a result
            of the payment transaction.
          $ref: '#/components/schemas/CashAccount40'
        creditor:
          description: Party to which an amount of money is due.
          $ref: '#/components/schemas/Party40Choice'
        creditor_account:
          description: >-
            Unambiguous identification of the account of the creditor to which a
            credit entry will be posted as a result of the payment transaction.
          $ref: '#/components/schemas/CashAccount40'
        ultimate_creditor:
          description: Ultimate party to which an amount of money is due.
          $ref: '#/components/schemas/Party40Choice'
        purpose:
          description: >-
            Underlying reason for the payment transaction.  Usage:  Purpose is
            used by the end customers, that is initiating party, (ultimate)
            debtor, (ultimate) creditor to provide information concerning the
            nature of the payment. Purpose is a content element, which is not
            used for processing by any of the agents involved in the payment
            chain.
          $ref: '#/components/schemas/Purpose2Choice'
    OtherContact1:
      type: object
      description: >-
        Communication device number or electronic address used for
        communication.
      additionalProperties: false
      properties:
        channel_type:
          description: >-
            Method used to contact the financial institution’s contact for the
            specific tax region.
          $ref: '#/components/schemas/Max4Text'
        identification:
          description: Communication value such as phone number or email address.
          $ref: '#/components/schemas/Max128Text'
      required:
        - channel_type
    Party38Choice:
      type: object
      description: Nature or use of the account.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            organisation_identification:
              description: Unique and unambiguous way to identify an organisation.
              $ref: '#/components/schemas/OrganisationIdentification29'
          required:
            - organisation_identification
        - type: object
          additionalProperties: false
          properties:
            private_identification:
              description: >-
                Unique and unambiguous identification of a person, for example a
                passport.
              $ref: '#/components/schemas/PersonIdentification13'
          required:
            - private_identification
    Party40Choice:
      type: object
      description: Identification of a person, an organisation or a financial institution.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            party:
              description: Identification of a person or an organisation.
              $ref: '#/components/schemas/PartyIdentification135'
          required:
            - party
        - type: object
          additionalProperties: false
          properties:
            agent:
              description: Identification of a financial institution.
              $ref: >-
                #/components/schemas/BranchAndFinancialInstitutionIdentification6
          required:
            - agent
    PartyIdentification135:
      type: object
      description: Specifies the identification of a person or an organisation.
      additionalProperties: false
      properties:
        name:
          description: >-
            Name by which a party is known and which is usually used to identify
            that party.
          $ref: '#/components/schemas/Max140Text'
        postal_address:
          description: >-
            Information that locates and identifies a specific address, as
            defined by postal services.
          $ref: '#/components/schemas/PostalAddress24'
        identification:
          description: Unique and unambiguous identification of a party.
          $ref: '#/components/schemas/Party38Choice'
        country_of_residence:
          description: >-
            Country in which a person resides (the place of a person's home). In
            the case of a company, it is the country from which the affairs of
            that company are directed.
          $ref: '#/components/schemas/CountryCode'
        contact_details:
          description: Set of elements used to indicate how to contact the party.
          $ref: '#/components/schemas/Contact4'
    PaymentMethod4Code:
      type: string
      description: >-
        Specifies the transfer method that will be used to transfer an amount of
        money.

        *`CHK`-Written order to a bank to pay a certain amount of money from one
        person to another person.

        *`TRF`-Transfer of an amount of money in the books of the account
        servicer.

        *`DD`-Collection of an amount of money from the debtor's bank account by
        the creditor. The amount of money and dates of collections may vary.

        *`TRA`-Transfer of an amount of money in the books of the account
        servicer. An advice should be sent back to the account owner.
      enum:
        - CHK
        - TRF
        - DD
        - TRA
    PaymentTransaction129:
      type: object
      description: >-
        Provides further details on the original transactions, to which the
        status report message refers.
      additionalProperties: false
      properties:
        status_identification:
          description: >-
            Unique identification, as assigned by an instructing party for an
            instructed party, to unambiguously identify the reported status.
            Usage: The instructing party is the party sending the status message
            and not the party that sent the original instruction that is being
            reported on.
          $ref: '#/components/schemas/Max35Text'
        original_instruction_identification:
          description: >-
            Unique identification, as assigned by the original instructing party
            for the original instructed party, to unambiguously identify the
            original instruction.
          $ref: '#/components/schemas/Max35Text'
        original_end_to_end_identification:
          description: >-
            Unique identification, as assigned by the original initiating party,
            to unambiguously identify the original transaction.
          $ref: '#/components/schemas/Max35Text'
        original_uetr:
          description: >-
            Universally unique identifier to provide the original end-to-end
            reference of a payment transaction.
          $ref: '#/components/schemas/UUIDv4Identifier'
        transaction_status:
          description: Specifies the status of a transaction, in a coded form.
          $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code'
        status_reason_information:
          type: array
          description: Provides detailed information on the status reason.
          items:
            $ref: '#/components/schemas/StatusReasonInformation12'
        charges_information:
          type: array
          description: >-
            Provides information on the charges related to the processing of the
            rejection of the instruction. Usage: This is passed on for
            information purposes only. Settlement of the charges will be done
            separately.
          items:
            $ref: '#/components/schemas/Charges7'
        tracker_data:
          description: >-
            Provides information on the tracking of the interbank transaction
            related to the payment.
          $ref: '#/components/schemas/TrackerData1'
        acceptance_date_time:
          description: >-
            Point in time when the payment order from the initiating party meets
            the processing conditions of the account servicing agent. This means
            that the account servicing agent has received the payment order and
            has applied checks such as authorisation, availability of funds.
          $ref: '#/components/schemas/ISODateTime'
        account_servicer_reference:
          description: >-
            Unique reference, as assigned by the account servicing institution,
            to unambiguously identify the instruction.
          $ref: '#/components/schemas/Max35Text'
        clearing_system_reference:
          description: >-
            Unique reference, as assigned by a clearing system, to unambiguously
            identify the instruction.
          $ref: '#/components/schemas/Max35Text'
        original_transaction_reference:
          description: >-
            Key elements used to identify the original transaction that is being
            referred to.
          $ref: '#/components/schemas/OriginalTransactionReference35'
        supplementary_data:
          type: array
          description: >-
            Additional information that cannot be captured in the structured
            elements and/or any other specific block.
          items:
            $ref: '#/components/schemas/SupplementaryData1'
    PaymentTypeInformation27:
      type: object
      description: Provides further details of the type of payment.
      additionalProperties: false
      properties:
        instruction_priority:
          description: >-
            Indicator of the urgency or order of importance that the instructing
            party would like the instructed party to apply to the processing of
            the instruction.
          $ref: '#/components/schemas/Priority2Code'
        clearing_channel:
          description: >-
            Specifies the clearing channel to be used to process the payment
            instruction.
          $ref: '#/components/schemas/ClearingChannel2Code'
        service_level:
          type: array
          description: >-
            Agreement under which or rules under which the transaction should be
            processed.
          items:
            $ref: '#/components/schemas/ServiceLevel8Choice'
        local_instrument:
          description: >-
            User community specific instrument.  Usage: This element is used to
            specify a local instrument, local clearing option and/or further
            qualify the service or service level.
          $ref: '#/components/schemas/LocalInstrument2Choice'
        sequence_type:
          description: >-
            Identifies the direct debit sequence, such as first, recurrent,
            final or one-off.
          $ref: '#/components/schemas/SequenceType3Code'
        category_purpose:
          description: >-
            Specifies the high level purpose of the instruction based on a set
            of pre-defined categories. Usage: This is used by the initiating
            party to provide information concerning the processing of the
            payment. It is likely to trigger special processing by any of the
            agents involved in the payment chain.
          $ref: '#/components/schemas/CategoryPurpose1Choice'
    PercentageRate:
      type: string
      description: >-
        Rate expressed as a percentage, that is, in hundredths, for example, 0.7
        is 7/10 of a percent, and 7.0 is 7%.
      maxLength: 12
    PersonIdentification13:
      type: object
      description: Unique and unambiguous way to identify a person.
      additionalProperties: false
      properties:
        date_and_place_of_birth:
          description: Date and place of birth of a person.
          $ref: '#/components/schemas/DateAndPlaceOfBirth1'
        other:
          type: array
          description: >-
            Unique identification of a person, as assigned by an institution,
            using an identification scheme.
          items:
            $ref: '#/components/schemas/GenericPersonIdentification1'
    PersonIdentificationSchemeName1Choice:
      type: object
      description: Sets of elements to identify a name of the identification scheme.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Name of the identification scheme, in a coded form as published
                in an external list.
              $ref: '#/components/schemas/ExternalPersonIdentification1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Name of the identification scheme, in a free text form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    PhoneNumber:
      type: string
      description: >-
        The collection of information which identifies a specific phone or FAX
        number as defined by telecom services.

        It consists of a "+" followed by the country code (from 1 to 3
        characters) then a "-" and finally, any combination of numbers, "(",
        ")", "+" and "-" (up to 30 characters).
      pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
    PostalAddress24:
      type: object
      description: >-
        Information that locates and identifies a specific address, as defined
        by postal services.
      additionalProperties: false
      properties:
        address_type:
          description: Identifies the nature of the postal address.
          $ref: '#/components/schemas/AddressType3Choice'
        department:
          description: Identification of a division of a large organisation or building.
          $ref: '#/components/schemas/Max70Text'
        sub_department:
          description: >-
            Identification of a sub-division of a large organisation or
            building.
          $ref: '#/components/schemas/Max70Text'
        street_name:
          description: Name of a street or thoroughfare.
          $ref: '#/components/schemas/Max70Text'
        building_number:
          description: Number that identifies the position of a building on a street.
          $ref: '#/components/schemas/Max16Text'
        building_name:
          description: Name of the building or house.
          $ref: '#/components/schemas/Max35Text'
        floor:
          description: Floor or storey within a building.
          $ref: '#/components/schemas/Max70Text'
        post_box:
          description: >-
            Numbered box in a post office, assigned to a person or organisation,
            where letters are kept until called for.
          $ref: '#/components/schemas/Max16Text'
        room:
          description: Building room number.
          $ref: '#/components/schemas/Max70Text'
        post_code:
          description: >-
            Identifier consisting of a group of letters and/or numbers that is
            added to a postal address to assist the sorting of mail.
          $ref: '#/components/schemas/Max16Text'
        town_name:
          description: >-
            Name of a built-up area, with defined boundaries, and a local
            government.
          $ref: '#/components/schemas/Max35Text'
        town_location_name:
          description: Specific location name within the town.
          $ref: '#/components/schemas/Max35Text'
        district_name:
          description: Identifies a subdivision within a country sub-division.
          $ref: '#/components/schemas/Max35Text'
        country_sub_division:
          description: Identifies a subdivision of a country such as state, region, county.
          $ref: '#/components/schemas/Max35Text'
        country:
          description: Nation with its own government.
          $ref: '#/components/schemas/CountryCode'
        address_line:
          type: array
          maxItems: 7
          description: >-
            Information that locates and identifies a specific address, as
            defined by postal services, presented in free format text.
          items:
            $ref: '#/components/schemas/Max70Text'
    PreferredContactMethod1Code:
      type: string
      description: >-
        Preferred method used to reach the individual contact within an
        organisation.

        *`LETT`-Preferred method used to reach the contact is per letter.

        *`MAIL`-Preferred method used to reach the contact is per email.

        *`PHON`-Preferred method used to reach the contact is per phone.

        *`FAXX`-Preferred method used to reach the contact is per fax.

        *`CELL`-Preferred method used to reach the contact is per mobile or cell
        phone.
      enum:
        - LETT
        - MAIL
        - PHON
        - FAXX
        - CELL
    Priority2Code:
      type: string
      description: |-
        Specifies the priority level of an event.
        *`HIGH`-Priority level is high.
        *`NORM`-Priority level is normal.
      enum:
        - HIGH
        - NORM
    ProxyAccountIdentification1:
      type: object
      description: Information related to a proxy  identification of the account.
      additionalProperties: false
      properties:
        type:
          description: Type of the proxy identification.
          $ref: '#/components/schemas/ProxyAccountType1Choice'
        identification:
          description: >-
            Identification used to indicate the account identification under
            another specified name.
          $ref: '#/components/schemas/Max2048Text'
      required:
        - identification
    ProxyAccountType1Choice:
      type: object
      description: Specifies the scheme used for the identification of an account alias.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Name of the identification scheme, in a coded form as published
                in an external list.
              $ref: '#/components/schemas/ExternalProxyAccountType1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Name of the identification scheme, in a free text form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    Purpose2Choice:
      type: object
      description: >-
        Specifies the underlying reason for the payment transaction.

        Usage: Purpose is used by the end-customers, that is initiating party,
        (ultimate) debtor, (ultimate) creditor to provide information concerning
        the nature of the payment. Purpose is a content element, which is not
        used for processing by any of the agents involved in the payment chain.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Underlying reason for the payment transaction, as published in
                an external purpose code list.
              $ref: '#/components/schemas/ExternalPurpose1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Purpose, in a proprietary form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    ReferredDocumentInformation7:
      type: object
      description: >-
        Set of elements used to identify the documents referred to in the
        remittance information.
      additionalProperties: false
      properties:
        type:
          description: Specifies the type of referred document.
          $ref: '#/components/schemas/ReferredDocumentType4'
        number:
          description: Unique and unambiguous identification of the referred document.
          $ref: '#/components/schemas/Max35Text'
        related_date:
          description: Date associated with the referred document.
          $ref: '#/components/schemas/ISODate'
        line_details:
          type: array
          description: >-
            Set of elements used to provide the content of the referred document
            line.
          items:
            $ref: '#/components/schemas/DocumentLineInformation1'
    ReferredDocumentType3Choice:
      type: object
      description: >-
        Specifies the type of the document referred in the remittance
        information.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: Document type in a coded form.
              $ref: '#/components/schemas/DocumentType6Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: >-
                Proprietary identification of the type of the remittance
                document.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    ReferredDocumentType4:
      type: object
      description: >-
        Specifies the type of the document referred in the remittance
        information.
      additionalProperties: false
      properties:
        code_or_proprietary:
          description: Provides the type details of the referred document.
          $ref: '#/components/schemas/ReferredDocumentType3Choice'
        issuer:
          description: Identification of the issuer of the reference document type.
          $ref: '#/components/schemas/Max35Text'
      required:
        - code_or_proprietary
    RemittanceAmount2:
      type: object
      description: >-
        Nature of the amount and currency on a document referred to in the
        remittance section, typically either the original amount due/payable or
        the amount actually remitted for the referenced document.
      additionalProperties: false
      properties:
        due_payable_amount:
          description: >-
            Amount specified is the exact amount due and payable to the
            creditor.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        discount_applied_amount:
          type: array
          description: >-
            Amount specified for the referred document is the amount of discount
            to be applied to the amount due and payable to the creditor.
          items:
            $ref: '#/components/schemas/DiscountAmountAndType1'
        credit_note_amount:
          description: >-
            Amount specified for the referred document is the amount of a credit
            note.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        tax_amount:
          type: array
          description: Quantity of cash resulting from the calculation of the tax.
          items:
            $ref: '#/components/schemas/TaxAmountAndType1'
        adjustment_amount_and_reason:
          type: array
          description: >-
            Specifies detailed information on the amount and reason of the
            document adjustment.
          items:
            $ref: '#/components/schemas/DocumentAdjustment1'
        remitted_amount:
          description: Amount of money remitted for the referred document.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
    RemittanceAmount3:
      type: object
      description: >-
        Nature of the amount and currency on a document referred to in the
        remittance section, typically either the original amount due/payable or
        the amount actually remitted for the referenced document.
      additionalProperties: false
      properties:
        due_payable_amount:
          description: >-
            Amount specified is the exact amount due and payable to the
            creditor.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        discount_applied_amount:
          type: array
          description: >-
            Amount of discount to be applied to the amount due and payable to
            the creditor.
          items:
            $ref: '#/components/schemas/DiscountAmountAndType1'
        credit_note_amount:
          description: Amount of a credit note.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        tax_amount:
          type: array
          description: Amount of the tax.
          items:
            $ref: '#/components/schemas/TaxAmountAndType1'
        adjustment_amount_and_reason:
          type: array
          description: >-
            Specifies detailed information on the amount and reason of the
            adjustment.
          items:
            $ref: '#/components/schemas/DocumentAdjustment1'
        remitted_amount:
          description: Amount of money remitted.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
    RemittanceInformation21:
      type: object
      description: >-
        Information supplied to enable the matching/reconciliation of an entry
        with the items that the payment is intended to settle, such as
        commercial invoices in an accounts' receivable system.
      additionalProperties: false
      properties:
        unstructured:
          type: array
          description: >-
            Information supplied to enable the matching/reconciliation of an
            entry with the items that the payment is intended to settle, such as
            commercial invoices in an accounts' receivable system, in an
            unstructured form.
          items:
            $ref: '#/components/schemas/Max140Text'
        structured:
          type: array
          description: >-
            Information supplied to enable the matching/reconciliation of an
            entry with the items that the payment is intended to settle, such as
            commercial invoices in an accounts' receivable system, in a
            structured form.
          items:
            $ref: '#/components/schemas/StructuredRemittanceInformation17'
    SequenceType3Code:
      type: string
      description: >-
        Specifies the type of the current transaction that belongs to a sequence
        of transactions.

        *`FRST`-First collection of a series of direct debit instructions.

        *`RCUR`-Direct debit instruction where the debtor's authorisation is
        used for regular direct debit transactions initiated by the creditor.

        *`FNAL`-Final collection of a series of direct debit instructions.

        *`OOFF`-Direct debit instruction where the debtor's authorisation is
        used to initiate one single direct debit transaction.

        *`RPRE`-Collection used to re-present previously reversed or returned
        direct debit transactions.
      enum:
        - FRST
        - RCUR
        - FNAL
        - OOFF
        - RPRE
    ServiceLevel8Choice:
      type: object
      description: Specifies the service level of the transaction.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Specifies a pre-agreed service or level of service between the
                parties, as published in an external service level code list.
              $ref: '#/components/schemas/ExternalServiceLevel1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: >-
                Specifies a pre-agreed service or level of service between the
                parties, as a proprietary code.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    SettlementInstruction11:
      type: object
      description: Provides further details on the settlement of the instruction.
      additionalProperties: false
      properties:
        settlement_method:
          description: Method used to settle the (batch of) payment instructions.
          $ref: '#/components/schemas/SettlementMethod1Code'
        settlement_account:
          description: >-
            A specific purpose account used to post debit and credit entries as
            a result of the transaction.
          $ref: '#/components/schemas/CashAccount40'
        clearing_system:
          description: >-
            Specification of a pre-agreed offering between clearing agents or
            the channel through which the payment instruction is processed.
          $ref: '#/components/schemas/ClearingSystemIdentification3Choice'
        instructing_reimbursement_agent:
          description: >-
            Agent through which the instructing agent will reimburse the
            instructed agent.  Usage: If InstructingAgent and InstructedAgent
            have the same reimbursement agent, then only
            InstructingReimbursementAgent must be used.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        instructing_reimbursement_agent_account:
          description: >-
            Unambiguous identification of the account of the instructing
            reimbursement agent account at its servicing agent in the payment
            chain.
          $ref: '#/components/schemas/CashAccount40'
        instructed_reimbursement_agent:
          description: >-
            Agent at which the instructed agent will be reimbursed. Usage: If
            InstructedReimbursementAgent contains a branch of the
            InstructedAgent, then the party in InstructedAgent will claim
            reimbursement from that branch/will be paid by that branch. Usage:
            If InstructingAgent and InstructedAgent have the same reimbursement
            agent, then only InstructingReimbursementAgent must be used.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        instructed_reimbursement_agent_account:
          description: >-
            Unambiguous identification of the account of the instructed
            reimbursement agent account at its servicing agent in the payment
            chain.
          $ref: '#/components/schemas/CashAccount40'
        third_reimbursement_agent:
          description: >-
            Agent at which the instructed agent will be reimbursed. Usage: If
            ThirdReimbursementAgent contains a branch of the InstructedAgent,
            then the party in InstructedAgent will claim reimbursement from that
            branch/will be paid by that branch.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        third_reimbursement_agent_account:
          description: >-
            Unambiguous identification of the account of the third reimbursement
            agent account at its servicing agent in the payment chain.
          $ref: '#/components/schemas/CashAccount40'
      required:
        - settlement_method
    SettlementMethod1Code:
      type: string
      description: >-
        Specifies the method used to settle the credit transfer instruction.

        *`INDA`-Settlement is done by the agent instructed to execute a payment
        instruction.

        *`INGA`-Settlement is done by the agent instructing and forwarding the
        payment to the next party in the payment chain.

        *`COVE`-Settlement is done through a cover payment.

        *`CLRG`-Settlement is done through a payment clearing system.
      enum:
        - INDA
        - INGA
        - COVE
        - CLRG
    StatusReason6Choice:
      type: object
      description: Specifies the reason for the status of the transaction.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Reason for the status, as published in an external reason code
                list.
              $ref: '#/components/schemas/ExternalStatusReason1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Reason for the status, in a proprietary form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    StatusReasonInformation12:
      type: object
      description: Provides information on the status reason of the transaction.
      additionalProperties: false
      properties:
        originator:
          description: Party that issues the status.
          $ref: '#/components/schemas/PartyIdentification135'
        reason:
          description: Specifies the reason for the status report.
          $ref: '#/components/schemas/StatusReason6Choice'
        additional_information:
          type: array
          description: >-
            Further details on the status reason.  Usage: Additional information
            can be used for several purposes such as the reporting of repaired
            information.
          items:
            $ref: '#/components/schemas/Max105Text'
    StructuredRemittanceInformation17:
      type: object
      description: >-
        Information supplied to enable the matching/reconciliation of an entry
        with the items that the payment is intended to settle, such as
        commercial invoices in an accounts' receivable system, in a structured
        form.
      additionalProperties: false
      properties:
        referred_document_information:
          type: array
          description: >-
            Provides the identification and the content of the referred
            document.
          items:
            $ref: '#/components/schemas/ReferredDocumentInformation7'
        referred_document_amount:
          description: Provides details on the amounts of the referred document.
          $ref: '#/components/schemas/RemittanceAmount2'
        creditor_reference_information:
          description: >-
            Reference information provided by the creditor to allow the
            identification of the underlying documents.
          $ref: '#/components/schemas/CreditorReferenceInformation2'
        invoicer:
          description: >-
            Identification of the organisation issuing the invoice, when it is
            different from the creditor or ultimate creditor.
          $ref: '#/components/schemas/PartyIdentification135'
        invoicee:
          description: >-
            Identification of the party to whom an invoice is issued, when it is
            different from the debtor or ultimate debtor.
          $ref: '#/components/schemas/PartyIdentification135'
        tax_remittance:
          description: >-
            Provides remittance information about a payment made for tax-related
            purposes.
          $ref: '#/components/schemas/TaxData1'
        garnishment_remittance:
          description: >-
            Provides remittance information about a payment for
            garnishment-related purposes.
          $ref: '#/components/schemas/Garnishment3'
        additional_remittance_information:
          type: array
          maxItems: 3
          description: >-
            Additional information, in free text form, to complement the
            structured remittance information.
          items:
            $ref: '#/components/schemas/Max140Text'
    SupplementaryData1:
      type: object
      description: >-
        Additional information that can not be captured in the structured fields
        and/or any other specific block.
      additionalProperties: false
      properties:
        place_and_name:
          description: >-
            Unambiguous reference to the location where the supplementary data
            must be inserted in the message instance. In the case of XML, this
            is expressed by a valid XPath.
          $ref: '#/components/schemas/Max350Text'
        envelope:
          description: Technical element wrapping the supplementary data.
          $ref: '#/components/schemas/SupplementaryDataEnvelope1'
      required:
        - envelope
    SupplementaryDataEnvelope1:
      type: object
      description: >-
        Technical component that contains the validated supplementary data
        information. This technical envelope allows to segregate the
        supplementary data information from any other information.
    TaxAmount3:
      type: object
      description: >-
        Set of elements used to provide information on the tax amount(s) of tax
        record.
      additionalProperties: false
      properties:
        rate:
          description: Rate used to calculate the tax.
          $ref: '#/components/schemas/PercentageRate'
        taxable_base_amount:
          description: Amount of money on which the tax is based.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        total_amount:
          description: >-
            Total amount that is the result of the calculation of the tax for
            the record.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        details:
          type: array
          description: >-
            Set of elements used to provide details on the tax period and
            amount.
          items:
            $ref: '#/components/schemas/TaxRecordDetails3'
    TaxAmountAndType1:
      type: object
      description: Specifies the amount with a specific type.
      additionalProperties: false
      properties:
        type:
          description: Specifies the type of the amount.
          $ref: '#/components/schemas/TaxAmountType1Choice'
        amount:
          description: Amount of money, which has been typed.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
      required:
        - amount
    TaxAmountType1Choice:
      type: object
      description: Specifies the amount type.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: Specifies the amount type, in a coded form.
              $ref: '#/components/schemas/ExternalTaxAmountType1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Specifies the amount type, in a free-text form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    TaxAuthorisation1:
      type: object
      description: Details of the authorised tax paying party.
      additionalProperties: false
      properties:
        title:
          description: >-
            Title or position of debtor or the debtor's authorised
            representative.
          $ref: '#/components/schemas/Max35Text'
        name:
          description: Name of the debtor or the debtor's authorised representative.
          $ref: '#/components/schemas/Max140Text'
    TaxData1:
      type: object
      description: >-
        Details about tax paid, or to be paid, to the government in accordance
        with the law, including pre-defined parameters such as thresholds and
        type of account.
      additionalProperties: false
      properties:
        creditor:
          description: >-
            Party on the credit side of the transaction to which the tax
            applies.
          $ref: '#/components/schemas/TaxParty1'
        debtor:
          description: Party on the debit side of the transaction to which the tax applies.
          $ref: '#/components/schemas/TaxParty2'
        ultimate_debtor:
          description: >-
            Ultimate party that owes an amount of money to the (ultimate)
            creditor, in this case, to the taxing authority.
          $ref: '#/components/schemas/TaxParty2'
        administration_zone:
          description: Territorial part of a country to which the tax payment is related.
          $ref: '#/components/schemas/Max35Text'
        reference_number:
          description: Tax reference information that is specific to a taxing agency.
          $ref: '#/components/schemas/Max140Text'
        method:
          description: >-
            Method used to indicate the underlying business or how the tax is
            paid.
          $ref: '#/components/schemas/Max35Text'
        total_taxable_base_amount:
          description: Total amount of money on which the tax is based.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        total_tax_amount:
          description: Total amount of money as result of the calculation of the tax.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        date:
          description: Date by which tax is due.
          $ref: '#/components/schemas/ISODate'
        sequence_number:
          description: Sequential number of the tax report.
          $ref: '#/components/schemas/Number'
        record:
          type: array
          description: Record of tax details.
          items:
            $ref: '#/components/schemas/TaxRecord3'
    TaxParty1:
      type: object
      description: Details about the entity involved in the tax paid or to be paid.
      additionalProperties: false
      properties:
        tax_identification:
          description: Tax identification number of the creditor.
          $ref: '#/components/schemas/Max35Text'
        registration_identification:
          description: >-
            Unique identification, as assigned by an organisation, to
            unambiguously identify a party.
          $ref: '#/components/schemas/Max35Text'
        tax_type:
          description: Type of tax payer.
          $ref: '#/components/schemas/Max35Text'
    TaxParty2:
      type: object
      description: Details about the entity involved in the tax paid or to be paid.
      additionalProperties: false
      properties:
        tax_identification:
          description: Tax identification number of the debtor.
          $ref: '#/components/schemas/Max35Text'
        registration_identification:
          description: >-
            Unique identification, as assigned by an organisation, to
            unambiguously identify a party.
          $ref: '#/components/schemas/Max35Text'
        tax_type:
          description: Type of tax payer.
          $ref: '#/components/schemas/Max35Text'
        authorisation:
          description: Details of the authorised tax paying party.
          $ref: '#/components/schemas/TaxAuthorisation1'
    TaxPeriod3:
      type: object
      description: Period of time details related to the tax payment.
      additionalProperties: false
      properties:
        year:
          description: Year related to the tax payment.
          $ref: '#/components/schemas/ISOYear'
        type:
          description: Identification of the period related to the tax payment.
          $ref: '#/components/schemas/TaxRecordPeriod1Code'
        from_to_date:
          description: >-
            Range of time between a start date and an end date for which the tax
            report is provided.
          $ref: '#/components/schemas/DatePeriod2'
    TaxRecord3:
      type: object
      description: Set of elements used to define the tax record.
      additionalProperties: false
      properties:
        type:
          description: High level code to identify the type of tax details.
          $ref: '#/components/schemas/Max35Text'
        category:
          description: Specifies the tax code as published by the tax authority.
          $ref: '#/components/schemas/Max35Text'
        category_details:
          description: Provides further details of the category tax code.
          $ref: '#/components/schemas/Max35Text'
        debtor_status:
          description: >-
            Code provided by local authority to identify the status of the party
            that has drawn up the settlement document.
          $ref: '#/components/schemas/Max35Text'
        certificate_identification:
          description: >-
            Identification number of the tax report as assigned by the taxing
            authority.
          $ref: '#/components/schemas/Max35Text'
        forms_code:
          description: >-
            Identifies, in a coded form, on which template the tax report is to
            be provided.
          $ref: '#/components/schemas/Max35Text'
        period:
          description: >-
            Set of elements used to provide details on the period of time
            related to the tax payment.
          $ref: '#/components/schemas/TaxPeriod3'
        tax_amount:
          description: >-
            Set of elements used to provide information on the amount of the tax
            record.
          $ref: '#/components/schemas/TaxAmount3'
        additional_information:
          description: Further details of the tax record.
          $ref: '#/components/schemas/Max140Text'
    TaxRecordDetails3:
      type: object
      description: >-
        Provides information on the individual tax amount(s) per period of the
        tax record.
      additionalProperties: false
      properties:
        period:
          description: >-
            Set of elements used to provide details on the period of time
            related to the tax payment.
          $ref: '#/components/schemas/TaxPeriod3'
        amount:
          description: Underlying tax amount related to the specified period.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
      required:
        - amount
    TaxRecordPeriod1Code:
      type: string
      description: |-
        Specifies the period related to the tax payment.
        *`MM01`-Tax is related to the second month of the period.
        *`MM02`-Tax is related to the first month of the period.
        *`MM03`-Tax is related to the third month of the period.
        *`MM04`-Tax is related to the fourth month of the period.
        *`MM05`-Tax is related to the fifth month of the period.
        *`MM06`-Tax is related to the sixth month of the period.
        *`MM07`-Tax is related to the seventh month of the period.
        *`MM08`-Tax is related to the eighth month of the period.
        *`MM09`-Tax is related to the ninth month of the period.
        *`MM10`-Tax is related to the tenth month of the period.
        *`MM11`-Tax is related to the eleventh month of the period.
        *`MM12`-Tax is related to the twelfth month of the period.
        *`QTR1`-Tax is related to the first quarter of the period.
        *`QTR2`-Tax is related to the second quarter of the period.
        *`QTR3`-Tax is related to the third quarter of the period.
        *`QTR4`-Tax is related to the forth quarter of the period.
        *`HLF1`-Tax is related to the first half of the period.
        *`HLF2`-Tax is related to the second half of the period.
      enum:
        - MM01
        - MM02
        - MM03
        - MM04
        - MM05
        - MM06
        - MM07
        - MM08
        - MM09
        - MM10
        - MM11
        - MM12
        - QTR1
        - QTR2
        - QTR3
        - QTR4
        - HLF1
        - HLF2
    TrackerData1:
      type: object
      description: >-
        Specifies the detailed information as provided by a payment tracking
        system.
      additionalProperties: false
      properties:
        confirmed_date:
          description: >-
            Point in time when an update to the tracking system has been
            confirmed.   Usage:  This date can be the point in time when an
            agent provides a pending status update to the tracking system or
            when the creditor has been credited and can use the amount of money
            (as confirmed to the tracking system by the creditor agent).
          $ref: '#/components/schemas/DateAndDateTime2Choice'
        confirmed_amount:
          description: Amount of money confirmed to the tracking system by the agent.
          $ref: '#/components/schemas/ActiveCurrencyAndAmount'
        tracker_record:
          type: array
          description: >-
            Provides tracker transaction information for a specific agent
            involved in the transaction chain. 
          items:
            $ref: '#/components/schemas/TrackerRecord1'
      required:
        - confirmed_date
        - confirmed_amount
        - tracker_record
    TrackerRecord1:
      type: object
      description: >-
        Specifies the agent specific tracking system information of a payment
        transaction.
      additionalProperties: false
      properties:
        agent:
          description: Identification of an agent in the tracker.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        charge_bearer:
          description: >-
            Specifies which party/parties will bear the charges associated with
            the processing of the payment transaction.
          $ref: '#/components/schemas/ChargeBearerType1Code'
        charges_amount:
          description: Transaction charges to be paid by the charge bearer.
          $ref: '#/components/schemas/ActiveCurrencyAndAmount'
        exchange_rate_data:
          description: >-
            Provides details of the rate and the currencies used in the foreign
            exchange.
          $ref: '#/components/schemas/CurrencyExchange13'
      required:
        - agent
    TrueFalseIndicator:
      type: boolean
      description: A flag indicating a True or False value.
    UUIDv4Identifier:
      type: string
      description: >-
        Universally Unique IDentifier (UUID) version 4, as described in IETC RFC
        4122 "Universally Unique IDentifier (UUID) URN Namespace".
      pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
    AdviceType1:
      type: object
      description: Specifies the type of advice to report back for the transaction.
      additionalProperties: false
      properties:
        credit_advice:
          description: Type of credit advice requested.
          $ref: '#/components/schemas/AdviceType1Choice'
        debit_advice:
          description: Type de debit advice requested.
          $ref: '#/components/schemas/AdviceType1Choice'
    AdviceType1Choice:
      type: object
      description: Specifies the type of advice requested for the transaction.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: Advice type, in a coded form.
              $ref: '#/components/schemas/AdviceType1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Advice type, in a proprietary form.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    AdviceType1Code:
      type: string
      description: |-
        Specifies the type of advice to provide back in the report.
        *`ADWD`-Advice with transaction details is requested.
        *`ADND`-Advice without  transaction details is requested.
      enum:
        - ADWD
        - ADND
    Authorisation1Choice:
      type: object
      description: >-
        Provides the details on the user identification or any user key that
        allows to check if the initiating party is allowed to issue the
        transaction.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: Specifies the authorisation, in a coded form.
              $ref: '#/components/schemas/Authorisation1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: Specifies the authorisation, in a free text form.
              $ref: '#/components/schemas/Max128Text'
          required:
            - proprietary
    Authorisation1Code:
      type: string
      description: >-
        Specifies the level of approval depending on a number of factors,
        including payment type, threshold amount or local country or operations
        practice.

        *`AUTH`-Indicates a file has been pre authorised or approved within the
        originating customer environment and no further approval is required.

        *`FDET`-Indicates that a file requires additional file level approval,
        with the ability to view both the payment information block and
        supporting customer credit transaction detail.

        *`FSUM`-Indicates that a file requires additional file level approval,
        with the ability to view only the payment information block level
        information.

        *`ILEV`-Indicates that a file requires all customer transactions to be
        authorised or approved.
      enum:
        - AUTH
        - FDET
        - FSUM
        - ILEV
    BatchBookingIndicator:
      type: boolean
      description: >-
        Identifies whether the sending party requests a single debit or credit
        entry per individual transaction or a batch entry for the sum of the
        amounts of all transactions.
    Cheque11:
      type: object
      description: >-
        Characteristics of a cheque instruction, such as cheque type or cheque
        number.
      additionalProperties: false
      properties:
        cheque_type:
          description: Specifies the type of cheque to be issued.
          $ref: '#/components/schemas/ChequeType2Code'
        cheque_number:
          description: >-
            Unique and unambiguous identifier for a cheque as assigned by the
            agent.
          $ref: '#/components/schemas/Max35Text'
        cheque_from:
          description: Identifies the party that ordered the issuance of the cheque.
          $ref: '#/components/schemas/NameAndAddress16'
        delivery_method:
          description: Specifies the delivery method of the cheque by the debtor's agent.
          $ref: '#/components/schemas/ChequeDeliveryMethod1Choice'
        deliver_to:
          description: Party to whom the debtor's agent needs to send the cheque.
          $ref: '#/components/schemas/NameAndAddress16'
        instruction_priority:
          description: >-
            Urgency or order of importance that the originator would like the
            recipient of the payment instruction to apply to the processing of
            the payment instruction.
          $ref: '#/components/schemas/Priority2Code'
        cheque_maturity_date:
          description: >-
            Date when the draft becomes payable and the debtor's account is
            debited.
          $ref: '#/components/schemas/ISODate'
        forms_code:
          description: >-
            Identifies, in a coded form, the cheque layout, company logo and
            digitised signature to be used to print the cheque, as agreed
            between the initiating party and the debtor's agent.
          $ref: '#/components/schemas/Max35Text'
        memo_field:
          type: array
          maxItems: 2
          description: >-
            Information that needs to be printed on a cheque, used by the payer
            to add miscellaneous information.
          items:
            $ref: '#/components/schemas/Max35Text'
        regional_clearing_zone:
          description: >-
            Regional area in which the cheque can be cleared, when a country has
            no nation-wide cheque clearing organisation.
          $ref: '#/components/schemas/Max35Text'
        print_location:
          description: Specifies the print location of the cheque.
          $ref: '#/components/schemas/Max35Text'
        signature:
          type: array
          maxItems: 5
          description: >-
            Signature to be used by the cheque servicer on a specific cheque to
            be printed.
          items:
            $ref: '#/components/schemas/Max70Text'
    ChequeDelivery1Code:
      type: string
      description: >-
        Specifies the method to be used in delivering a cheque to a party.

        *`MLDB`-Cheque is to be sent through mail services to debtor.

        *`MLCD`-Cheque is to be sent through mail services to creditor.

        *`MLFA`-Cheque is to be sent through mail services to creditor agent.

        *`CRDB`-Cheque is to be sent through courier services to debtor.

        *`CRCD`-Cheque is to be sent through courier services to creditor.

        *`CRFA`-Cheque is to be sent through courier services to creditor agent.

        *`PUDB`-Cheque will be picked up by the debtor.

        *`PUCD`-Cheque will be picked up by the creditor.

        *`PUFA`-Cheque will be picked up by the creditor agent.

        *`RGDB`-Cheque is to be sent through registered mail services to debtor.

        *`RGCD`-Cheque is to be sent through registered mail services to
        creditor.

        *`RGFA`-Cheque is to be sent through registered mail services to
        creditor agent.
      enum:
        - MLDB
        - MLCD
        - MLFA
        - CRDB
        - CRCD
        - CRFA
        - PUDB
        - PUCD
        - PUFA
        - RGDB
        - RGCD
        - RGFA
    ChequeDeliveryMethod1Choice:
      type: object
      description: >-
        Set of characteristics related to a cheque instruction, such as cheque
        type or cheque number.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            code:
              description: >-
                Specifies the delivery method of the cheque by the debtor's
                agent.
              $ref: '#/components/schemas/ChequeDelivery1Code'
          required:
            - code
        - type: object
          additionalProperties: false
          properties:
            proprietary:
              description: >-
                Specifies a proprietary delivery method of the cheque by the
                debtor's agent.
              $ref: '#/components/schemas/Max35Text'
          required:
            - proprietary
    ChequeType2Code:
      type: string
      description: >-
        Specifies the type of cheque.

        *`CCHQ`-Cheque drawn on the account of the debtor, and debited on the
        debtor's account when the cheque is cashed. Synonym is 'corporate
        cheque'.

        *`CCCH`-Cheque drawn on the account of the debtor, and debited on the
        debtor's account when the cheque is cashed. The financial institution
        prints and certifies the cheque, guaranteeing the payment.

        *`BCHQ`-Cheque drawn on the account of the debtor's financial
        institution, which is debited on the debtor's account when the cheque is
        issued.These cheques are printed by the debtor's financial institution
        and payment is guaranteed by the financial institution. Synonym is
        'cashier's cheque'.

        *`DRFT`-A guaranteed bank cheque with a future value date (do not pay
        before], which in commercial terms is a 'negotiatable instrument': the
        beneficiary can receive early payment from any bank under subtraction of
        a discount. The ordering customer's account is debited on value date.

        *`ELDR`-An instrument with a future value date (do not pay before],
        which in commercial terms is a 'negotiatable instrument': the
        beneficiary can receive early payment from any bank under subtraction of
        a discount. The ordering customer's account is debited on value date.
      enum:
        - CCHQ
        - CCCH
        - BCHQ
        - DRFT
        - ELDR
    CreditTransferTransaction54:
      type: object
      description: >-
        Provide further details specific to the individual transaction(s)
        included in the message.
      additionalProperties: false
      properties:
        payment_identification:
          description: Set of elements used to reference a payment instruction.
          $ref: '#/components/schemas/PaymentIdentification6'
        payment_type_information:
          description: Set of elements used to further specify the type of transaction.
          $ref: '#/components/schemas/PaymentTypeInformation26'
        amount:
          description: >-
            Amount of money to be moved between the debtor and creditor, before
            deduction of charges, expressed in the currency as ordered by the
            initiating party.
          $ref: '#/components/schemas/AmountType4Choice'
        exchange_rate_information:
          description: Provides details on the currency exchange rate and contract.
          $ref: '#/components/schemas/ExchangeRate1'
        charge_bearer:
          description: >-
            Specifies which party/parties will bear the charges associated with
            the processing of the payment transaction.
          $ref: '#/components/schemas/ChargeBearerType1Code'
        mandate_related_information:
          description: >-
            Provides further details of the mandate signed between the creditor
            and the debtor.
          $ref: '#/components/schemas/CreditTransferMandateData1'
        cheque_instruction:
          description: Set of elements needed to issue a cheque.
          $ref: '#/components/schemas/Cheque11'
        ultimate_debtor:
          description: >-
            Ultimate party that owes an amount of money to the (ultimate)
            creditor.
          $ref: '#/components/schemas/PartyIdentification135'
        intermediary_agent1:
          description: >-
            Agent between the debtor's agent and the creditor's agent.  Usage:
            If more than one intermediary agent is present, then
            IntermediaryAgent1 identifies the agent between the DebtorAgent and
            the IntermediaryAgent2.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        intermediary_agent1_account:
          description: >-
            Unambiguous identification of the account of the intermediary agent
            1 at its servicing agent in the payment chain.
          $ref: '#/components/schemas/CashAccount40'
        intermediary_agent2:
          description: >-
            Agent between the debtor's agent and the creditor's agent.  Usage:
            If more than two intermediary agents are present, then
            IntermediaryAgent2 identifies the agent between the
            IntermediaryAgent1 and the IntermediaryAgent3.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        intermediary_agent2_account:
          description: >-
            Unambiguous identification of the account of the intermediary agent
            2 at its servicing agent in the payment chain.
          $ref: '#/components/schemas/CashAccount40'
        intermediary_agent3:
          description: >-
            Agent between the debtor's agent and the creditor's agent.  Usage:
            If IntermediaryAgent3 is present, then it identifies the agent
            between the IntermediaryAgent 2 and the CreditorAgent.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        intermediary_agent3_account:
          description: >-
            Unambiguous identification of the account of the intermediary agent
            3 at its servicing agent in the payment chain.
          $ref: '#/components/schemas/CashAccount40'
        creditor_agent:
          description: Financial institution servicing an account for the creditor.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        creditor_agent_account:
          description: >-
            Unambiguous identification of the account of the creditor agent at
            its servicing agent to which a credit entry will be made as a result
            of the payment transaction.
          $ref: '#/components/schemas/CashAccount40'
        creditor:
          description: Party to which an amount of money is due.
          $ref: '#/components/schemas/PartyIdentification135'
        creditor_account:
          description: >-
            Unambiguous identification of the account of the creditor to which a
            credit entry will be posted as a result of the payment transaction.
          $ref: '#/components/schemas/CashAccount40'
        ultimate_creditor:
          description: Ultimate party to which an amount of money is due.
          $ref: '#/components/schemas/PartyIdentification135'
        instruction_for_creditor_agent:
          type: array
          description: >-
            Further information related to the processing of the payment
            instruction, provided by the initiating party, and intended for the
            creditor agent.
          items:
            $ref: '#/components/schemas/InstructionForCreditorAgent3'
        instruction_for_debtor_agent:
          description: >-
            Further information related to the processing of the payment
            instruction, that may need to be acted upon by the debtor agent,
            depending on agreement between debtor and the debtor agent.
          $ref: '#/components/schemas/InstructionForDebtorAgent1'
        purpose:
          description: >-
            Underlying reason for the payment transaction. Usage: Purpose is
            used by the end-customers, that is initiating party, (ultimate)
            debtor, (ultimate) creditor to provide information concerning the
            nature of the payment. Purpose is a content element, which is not
            used for processing by any of the agents involved in the payment
            chain.
          $ref: '#/components/schemas/Purpose2Choice'
        regulatory_reporting:
          type: array
          maxItems: 10
          description: Information needed due to regulatory and statutory requirements.
          items:
            $ref: '#/components/schemas/RegulatoryReporting3'
        tax:
          description: Provides details on the tax.
          $ref: '#/components/schemas/TaxInformation10'
        related_remittance_information:
          type: array
          maxItems: 10
          description: >-
            Provides information related to the handling of the remittance
            information by any of the agents in the transaction processing
            chain.
          items:
            $ref: '#/components/schemas/RemittanceLocation7'
        remittance_information:
          description: >-
            Information supplied to enable the matching of an entry with the
            items that the transfer is intended to settle, such as commercial
            invoices in an accounts' receivable system.
          $ref: '#/components/schemas/RemittanceInformation21'
        supplementary_data:
          type: array
          description: >-
            Additional information that cannot be captured in the structured
            elements and/or any other specific block.
          items:
            $ref: '#/components/schemas/SupplementaryData1'
      required:
        - payment_identification
        - amount
    CustomerCreditTransferInitiationV11Document:
      description: CustomerCreditTransferInitiationV11 Document
      type: object
      required:
        - customer_credit_transfer_initiation
      additionalProperties: false
      properties:
        customer_credit_transfer_initiation:
          $ref: '#/components/schemas/CustomerCreditTransferInitiationV11'
    CustomerCreditTransferInitiationV11:
      type: object
      description: >-
        **Scope**


        The CustomerCreditTransferInitiation message is sent by the initiating
        party to the forwarding agent or debtor agent. It is used to request
        movement of funds from the debtor account to a creditor.


        **Usage**


        The CustomerCreditTransferInitiation message can contain one or more
        customer credit transfer instructions.


        The CustomerCreditTransferInitiation message is used to exchange:


        - One or more instances of a credit transfer initiation;

        - Payment transactions that result in book transfers at the debtor agent
        or payments to another financial institution;

        - Payment transactions that result in an electronic cash transfer to the
        creditor account or in the emission of a cheque.


        The message can be used in a direct or a relay scenario:


        - In a direct scenario, the message is sent directly to the debtor
        agent. The debtor agent is the account servicer of the debtor.

        - In a relay scenario, the message is sent to a forwarding agent. The
        forwarding agent acts as a concentrating financial institution. It will
        forward the CustomerCreditTransferInitiation message to the debtor
        agent.


        The message can also be used by an initiating party that has authority
        to send the message on behalf of the debtor. This caters for example for
        the scenario of a payments factory initiating all payments on behalf of
        a large corporate.


        The CustomerCreditTransferInitiation message can be used in domestic and
        cross-border scenarios.


        The CustomerCreditTransferInitiation message must not be used by the
        debtor agent to execute the credit transfer instruction(s). The
        FIToFICustomerCreditTransfer message must be used instead.
      additionalProperties: false
      properties:
        group_header:
          description: >-
            Set of characteristics shared by all individual transactions
            included in the message.
          $ref: '#/components/schemas/GroupHeader95'
        payment_information:
          type: array
          description: >-
            Set of characteristics that applies to the debit side of the payment
            transactions included in the credit transfer initiation.
          items:
            $ref: '#/components/schemas/PaymentInstruction40'
        supplementary_data:
          type: array
          description: >-
            Additional information that cannot be captured in the structured
            elements and/or any other specific block.
          items:
            $ref: '#/components/schemas/SupplementaryData1'
      required:
        - group_header
        - payment_information
    ExchangeRate1:
      type: object
      description: >-
        Further detailed information on the exchange rate that has been used in
        the payment transaction.
      additionalProperties: false
      properties:
        unit_currency:
          description: >-
            Currency in which the rate of exchange is expressed in a currency
            exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
        exchange_rate:
          description: >-
            The factor used for conversion of an amount from one currency to
            another. This reflects the price at which one currency was bought
            with another currency.
          $ref: '#/components/schemas/BaseOneRate'
        rate_type:
          description: Specifies the type used to complete the currency exchange.
          $ref: '#/components/schemas/ExchangeRateType1Code'
        contract_identification:
          description: >-
            Unique and unambiguous reference to the foreign exchange contract
            agreed between the initiating party/creditor and the debtor agent.
          $ref: '#/components/schemas/Max35Text'
    ExchangeRateType1Code:
      type: string
      description: >-
        Specifies a type of financial or commercial document.

        *`SPOT`-Exchange rate applied is the spot rate.

        *`SALE`-Exchange rate applied is the market rate at the time of the
        sale.

        *`AGRD`-Exchange rate applied is the rate agreed between the parties.
      enum:
        - SPOT
        - SALE
        - AGRD
    ExternalCreditorAgentInstruction1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: >-
        Specifies further instructions concerning the processing of a payment
        instruction, as provided to the creditor agent.

        *`CHQB`-(Ultimate) creditor must be paid by cheque.

        *`HOLD`-Amount of money must be held for the (ultimate) creditor, who
        will call. Pay on identification.

        *`PHOB`-Please advise/contact (ultimate) creditor/claimant by phone.

        *`PRTK`-Indicates that a payer token is requested/used.

        *`RECI`-Further information regarding the intended recipient. 

        *`TELB`-Please advise/contact (ultimate) creditor/claimant by the most
        efficient means of telecommunication.

        *`TKCM`-Token found with counterparty mismatch. 

        *`TKSG`-Single Use Token already used. 

        *`TKSP`-Token found with suspended status.

        *`TKVE`-Token found with value limit rule violation. 

        *`TKXP`-Token expired. 

        *`TOKN`-Token information.

        *`VLTK`-Additional validation information to be used in conjunction with
        the token.

        *`SEID`-Use of Secondary Identification of Creditor Account (which may
        relate to Head Office Collection Account, Building Society Roll Number
        or Credit Card Primary Account Number).
      enum:
        - CHQB
        - HOLD
        - PHOB
        - PRTK
        - RECI
        - TELB
        - TKCM
        - TKSG
        - TKSP
        - TKVE
        - TKXP
        - TOKN
        - VLTK
        - SEID
    ExternalDebtorAgentInstruction1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: >-
        Specifies further instructions concerning the processing of a payment
        instruction, as provided to the creditor agent.

        *`HOLD`-Amount of money must be held for the (ultimate) creditor, who
        will call. Pay on identification.

        *`CHQB`-(Ultimate) creditor must be paid by cheque.

        *`PRTK`-Indicates that a payer token is requested/used.

        *`PHOB`-Please advise/contact (ultimate) creditor/claimant by phone.

        *`TELB`-Please advise/contact (ultimate) creditor/claimant by the most
        efficient means of telecommunication.

        *`TOKN`-Token information.

        *`VLTK`-Additional validation information to be used in conjunction with
        the token.
      enum:
        - HOLD
        - CHQB
        - PRTK
        - PHOB
        - TELB
        - TOKN
        - VLTK
    GroupHeader95:
      type: object
      description: >-
        Set of characteristics shared by all individual transactions included in
        the message.
      additionalProperties: false
      properties:
        message_identification:
          description: >-
            Point to point reference, as assigned by the instructing party, and
            sent to the next party in the chain to unambiguously identify the
            message. Usage: The instructing party has to make sure that
            MessageIdentification is unique per instructed party for a
            pre-agreed period.
          $ref: '#/components/schemas/Max35Text'
        creation_date_time:
          description: Date and time at which the message was created.
          $ref: '#/components/schemas/ISODateTime'
        authorisation:
          type: array
          maxItems: 2
          description: >-
            User identification or any user key to be used to check whether the
            initiating party is allowed to initiate transactions from the
            account specified in the message.  Usage: The content is not of a
            technical nature, but reflects the organisational structure at the
            initiating side. The authorisation element can typically be used in
            relay scenarios, payment initiations, payment returns or payment
            reversals that are initiated on behalf of a party different from the
            initiating party.
          items:
            $ref: '#/components/schemas/Authorisation1Choice'
        number_of_transactions:
          description: Number of individual transactions contained in the message.
          $ref: '#/components/schemas/Max15NumericText'
        control_sum:
          description: >-
            Total of all individual amounts included in the message,
            irrespective of currencies.
          $ref: '#/components/schemas/DecimalNumber'
        initiating_party:
          description: >-
            Party that initiates the payment.  Usage: This can either be the
            debtor or the party that initiates the credit transfer on behalf of
            the debtor.
          $ref: '#/components/schemas/PartyIdentification135'
        forwarding_agent:
          description: >-
            Financial institution that receives the instruction from the
            initiating party and forwards it to the next agent in the payment
            chain for execution.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        initiation_source:
          description: Source application or software used to initiate the payment.
          $ref: '#/components/schemas/PaymentInitiationSource1'
      required:
        - message_identification
        - creation_date_time
        - number_of_transactions
        - initiating_party
    ISODateTime:
      type: string
      description: >-
        A particular point in the progression of time defined by a mandatory
        date and a mandatory time component, expressed in either UTC time format
        (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format
        (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format
        (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML
        Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October
        2004" which is aligned with ISO 8601.

        Note on the time format:

        1) beginning / end of calendar day

        00:00:00 = the beginning of a calendar day

        24:00:00 = the end of a calendar day

        2) fractions of second in time format

        Decimal fractions of seconds may be included. In this case, the involved
        parties shall agree on the maximum number of digits that are allowed.
      pattern: >-
        ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.[0-9]+)?(?:Z|[+-][01]\d:[0-5]\d)?$
    InstructionForCreditorAgent3:
      type: object
      description: >-
        Further information related to the processing of the payment instruction
        that may need to be acted upon by the creditor's agent. The instruction
        may relate to a level of service, or may be an instruction that has to
        be executed by the creditor's agent, or may be information required by
        the creditor's agent.
      additionalProperties: false
      properties:
        code:
          description: >-
            Coded information related to the processing of the payment
            instruction, provided by the initiating party, and intended for the
            creditor's agent.
          $ref: '#/components/schemas/ExternalCreditorAgentInstruction1Code'
        instruction_information:
          description: >-
            Further information complementing the coded instruction or
            instruction to the creditor's agent that is bilaterally agreed or
            specific to a user community.
          $ref: '#/components/schemas/Max140Text'
    InstructionForDebtorAgent1:
      type: object
      description: >-
        Further information related to the processing of the payment instruction
        that may need to be acted upon by the debtor's agent. The instruction
        may relate to a level of service, or may be an instruction that has to
        be executed by the debtor's agent, or may be information required by the
        debtor's agent.
      additionalProperties: false
      properties:
        code:
          description: >-
            Coded information related to the processing of the payment
            instruction, provided by the initiating party, and intended for the
            creditor's agent.
          $ref: '#/components/schemas/ExternalDebtorAgentInstruction1Code'
        instruction_information:
          description: >-
            Further information complementing the coded instruction or
            instruction to the creditor's agent that is bilaterally agreed or
            specific to a user community.
          $ref: '#/components/schemas/Max140Text'
    Max10Text:
      type: string
      description: Specifies a character string with a maximum length of 10 characters.
      minLength: 1
      maxLength: 10
    NameAndAddress16:
      type: object
      description: Information that locates and identifies a party.
      additionalProperties: false
      properties:
        name:
          description: >-
            Name by which a party is known and is usually used to identify that
            party.
          $ref: '#/components/schemas/Max140Text'
        address:
          description: Postal address of a party.
          $ref: '#/components/schemas/PostalAddress24'
      required:
        - name
        - address
    PaymentIdentification6:
      type: object
      description: Provides further means of referencing a payment transaction.
      additionalProperties: false
      properties:
        instruction_identification:
          description: >-
            Unique identification as assigned by an instructing party for an
            instructed party to unambiguously identify the instruction.  Usage:
            The instruction identification is a point to point reference that
            can be used between the instructing party and the instructed party
            to refer to the individual instruction. It can be included in
            several messages related to the instruction.
          $ref: '#/components/schemas/Max35Text'
        end_to_end_identification:
          description: >-
            Unique identification assigned by the initiating party to
            unambiguously identify the transaction. This identification is
            passed on, unchanged, throughout the entire end-to-end chain. 
            Usage: The end-to-end identification can be used for reconciliation
            or to link tasks relating to the transaction. It can be included in
            several messages related to the transaction.
          $ref: '#/components/schemas/Max35Text'
        uetr:
          description: >-
            Universally unique identifier to provide an end-to-end reference of
            a payment transaction.
          $ref: '#/components/schemas/UUIDv4Identifier'
      required:
        - end_to_end_identification
    PaymentInitiationSource1:
      type: object
      description: >-
        Specifies the source used to initiate the payment (such as an
        application or a software).
      additionalProperties: false
      properties:
        name:
          description: Name of the application or software used to initiate the payment.
          $ref: '#/components/schemas/Max140Text'
        provider:
          description: >-
            Provider of the application or software used to initiate the
            payment.
          $ref: '#/components/schemas/Max35Text'
        version:
          description: Version of the application or software used to initiate the payment.
          $ref: '#/components/schemas/Max35Text'
      required:
        - name
    PaymentInstruction40:
      type: object
      description: >-
        Characteristics that apply to the debit side of the payment transactions
        included in the credit transfer initiation.
      additionalProperties: false
      properties:
        payment_information_identification:
          description: >-
            Unique identification, as assigned by a sending party, to
            unambiguously identify the payment information group within the
            message.
          $ref: '#/components/schemas/Max35Text'
        payment_method:
          description: >-
            Specifies the means of payment that will be used to move the amount
            of money.
          $ref: '#/components/schemas/PaymentMethod3Code'
        requested_advice_type:
          description: Type of advice details requested.
          $ref: '#/components/schemas/AdviceType1'
        batch_booking:
          description: >-
            Identifies whether a single entry per individual transaction or a
            batch entry for the sum of the amounts of all transactions within
            the group of a message is requested. Usage: Batch booking is used to
            request and not order a possible batch booking.
          $ref: '#/components/schemas/BatchBookingIndicator'
        number_of_transactions:
          description: >-
            Number of individual transactions contained in the payment
            information group.
          $ref: '#/components/schemas/Max15NumericText'
        control_sum:
          description: >-
            Total of all individual amounts included in the group, irrespective
            of currencies.
          $ref: '#/components/schemas/DecimalNumber'
        payment_type_information:
          description: Set of elements used to further specify the type of transaction.
          $ref: '#/components/schemas/PaymentTypeInformation26'
        requested_execution_date:
          description: >-
            Date at which the initiating party requests the clearing agent to
            process the payment.  Usage: This is the date on which the debtor's
            account is to be debited. If payment by cheque, the date when the
            cheque must be generated by the bank.
          $ref: '#/components/schemas/DateAndDateTime2Choice'
        pooling_adjustment_date:
          description: >-
            Date used for the correction of the value date of a cash pool
            movement that has been posted with a different value date.
          $ref: '#/components/schemas/ISODate'
        debtor:
          description: Party that owes an amount of money to the (ultimate) creditor.
          $ref: '#/components/schemas/PartyIdentification135'
        debtor_account:
          description: >-
            Unambiguous identification of the account of the debtor to which a
            debit entry will be made as a result of the transaction.
          $ref: '#/components/schemas/CashAccount40'
        debtor_agent:
          description: Financial institution servicing an account for the debtor.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        debtor_agent_account:
          description: >-
            Unambiguous identification of the account of the debtor agent at its
            servicing agent in the payment chain.
          $ref: '#/components/schemas/CashAccount40'
        instruction_for_debtor_agent:
          description: >-
            Further information related to the processing of the payment
            instruction, that may need to be acted upon by the debtor agent,
            depending on agreement between debtor and the debtor agent.  Usage:
            when present, then the instructions for the debtor agent apply for
            all credit transfer transaction information occurrences, present in
            the payment information.
          $ref: '#/components/schemas/Max140Text'
        ultimate_debtor:
          description: >-
            Ultimate party that owes an amount of money to the (ultimate)
            creditor.
          $ref: '#/components/schemas/PartyIdentification135'
        charge_bearer:
          description: >-
            Specifies which party/parties will bear the charges associated with
            the processing of the payment transaction.
          $ref: '#/components/schemas/ChargeBearerType1Code'
        charges_account:
          description: >-
            Account used to process charges associated with a transaction. 
            Usage: Charges account should be used when charges have to be booked
            to an account different from the account identified in debtor's
            account.
          $ref: '#/components/schemas/CashAccount40'
        charges_account_agent:
          description: >-
            Agent that services a charges account.  Usage: Charges account agent
            should only be used when the charges account agent is different from
            the debtor agent.
          $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification6'
        credit_transfer_transaction_information:
          type: array
          description: >-
            Provides information on the individual transaction(s) included in
            the message.
          items:
            $ref: '#/components/schemas/CreditTransferTransaction54'
      required:
        - payment_information_identification
        - payment_method
        - requested_execution_date
        - debtor
        - debtor_account
        - debtor_agent
        - credit_transfer_transaction_information
    PaymentMethod3Code:
      type: string
      description: >-
        Specifies the transfer method that will be used to transfer an amount of
        money.

        *`CHK`-Written order to a bank to pay a certain amount of money from one
        person to another person.

        *`TRF`-Transfer of an amount of money in the books of the account
        servicer.

        *`TRA`-Transfer of an amount of money in the books of the account
        servicer. An advice should be sent back to the account owner.
      enum:
        - CHK
        - TRF
        - TRA
    PaymentTypeInformation26:
      type: object
      description: Provides further details of the type of payment.
      additionalProperties: false
      properties:
        instruction_priority:
          description: >-
            Indicator of the urgency or order of importance that the instructing
            party would like the instructed party to apply to the processing of
            the instruction.
          $ref: '#/components/schemas/Priority2Code'
        service_level:
          type: array
          description: >-
            Agreement under which or rules under which the transaction should be
            processed.
          items:
            $ref: '#/components/schemas/ServiceLevel8Choice'
        local_instrument:
          description: >-
            User community specific instrument.  Usage: This element is used to
            specify a local instrument, local clearing option and/or further
            qualify the service or service level.
          $ref: '#/components/schemas/LocalInstrument2Choice'
        category_purpose:
          description: >-
            Specifies the high level purpose of the instruction based on a set
            of pre-defined categories. Usage: This is used by the initiating
            party to provide information concerning the processing of the
            payment. It is likely to trigger special processing by any of the
            agents involved in the payment chain.
          $ref: '#/components/schemas/CategoryPurpose1Choice'
    RegulatoryAuthority2:
      type: object
      description: Entity requiring the regulatory reporting information.
      additionalProperties: false
      properties:
        name:
          description: Name of the entity requiring the regulatory reporting information.
          $ref: '#/components/schemas/Max140Text'
        country:
          description: >-
            Country of the entity that requires the regulatory reporting
            information.
          $ref: '#/components/schemas/CountryCode'
    RegulatoryReporting3:
      type: object
      description: Information needed due to regulatory and/or statutory requirements.
      additionalProperties: false
      properties:
        debit_credit_reporting_indicator:
          description: >-
            Identifies whether the regulatory reporting information applies to
            the debit side, to the credit side or to both debit and credit sides
            of the transaction.
          $ref: '#/components/schemas/RegulatoryReportingType1Code'
        authority:
          description: Entity requiring the regulatory reporting information.
          $ref: '#/components/schemas/RegulatoryAuthority2'
        details:
          type: array
          description: >-
            Set of elements used to provide details on the regulatory reporting
            information.
          items:
            $ref: '#/components/schemas/StructuredRegulatoryReporting3'
    RegulatoryReportingType1Code:
      type: string
      description: >-
        Identifies whether the regulatory reporting information applies to the
        debit side, to the credit side or to both debit and credit sides of the
        transaction.

        *`CRED`-Regulatory information applies to the credit side.

        *`DEBT`-Regulatory information applies to the debit side.

        *`BOTH`-Regulatory information applies to both credit and debit sides.
      enum:
        - CRED
        - DEBT
        - BOTH
    RemittanceLocation7:
      type: object
      description: Provides information on the remittance advice.
      additionalProperties: false
      properties:
        remittance_identification:
          description: >-
            Unique identification, as assigned by the initiating party, to
            unambiguously identify the remittance information sent separately
            from the payment instruction, such as a remittance advice.
          $ref: '#/components/schemas/Max35Text'
        remittance_location_details:
          type: array
          description: >-
            Set of elements used to provide information on the location and/or
            delivery of the remittance information.
          items:
            $ref: '#/components/schemas/RemittanceLocationData1'
    RemittanceLocationData1:
      type: object
      description: Provides additional details on the remittance advice.
      additionalProperties: false
      properties:
        method:
          description: Method used to deliver the remittance advice information.
          $ref: '#/components/schemas/RemittanceLocationMethod2Code'
        electronic_address:
          description: >-
            Electronic address to which an agent is to send the remittance
            information.
          $ref: '#/components/schemas/Max2048Text'
        postal_address:
          description: >-
            Postal address to which an agent is to send the remittance
            information.
          $ref: '#/components/schemas/NameAndAddress16'
      required:
        - method
    RemittanceLocationMethod2Code:
      type: string
      description: >-
        Specifies the method used to deliver the remittance advice information.

        *`FAXI`-Remittance advice information must be faxed.

        *`EDIC`-Remittance advice information must be sent through Electronic
        Data Interchange (EDI).

        *`URID`-Remittance advice information needs to be sent to a Uniform
        Resource Identifier (URI). URI is a compact string of characters that
        uniquely identify an abstract or physical resource. URI's are the
        super-set of identifiers, such as URLs, email addresses, ftp sites, etc,
        and as such, provide the syntax for all of the identification schemes.

        *`EMAL`-Remittance advice information must be sent through e-mail.

        *`POST`-Remittance advice information must be sent through postal
        services.

        *`SMSM`-Remittance advice information must be sent through by phone as a
        short message service (SMS).
      enum:
        - FAXI
        - EDIC
        - URID
        - EMAL
        - POST
        - SMSM
    StructuredRegulatoryReporting3:
      type: object
      description: Information needed due to regulatory and statutory requirements.
      additionalProperties: false
      properties:
        type:
          description: >-
            Specifies the type of the information supplied in the regulatory
            reporting details.
          $ref: '#/components/schemas/Max35Text'
        date:
          description: Date related to the specified type of regulatory reporting details.
          $ref: '#/components/schemas/ISODate'
        country:
          description: >-
            Country related to the specified type of regulatory reporting
            details.
          $ref: '#/components/schemas/CountryCode'
        code:
          description: >-
            Specifies the nature, purpose, and reason for the transaction to be
            reported for regulatory and statutory requirements in a coded form.
          $ref: '#/components/schemas/Max10Text'
        amount:
          description: >-
            Amount of money to be reported for regulatory and statutory
            requirements.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        information:
          type: array
          description: >-
            Additional details that cater for specific domestic regulatory
            requirements.
          items:
            $ref: '#/components/schemas/Max35Text'
    TaxInformation10:
      type: object
      description: >-
        Details about tax paid, or to be paid, to the government in accordance
        with the law, including pre-defined parameters such as thresholds and
        type of account.
      additionalProperties: false
      properties:
        creditor:
          description: >-
            Party on the credit side of the transaction to which the tax
            applies.
          $ref: '#/components/schemas/TaxParty1'
        debtor:
          description: Party on the debit side of the transaction to which the tax applies.
          $ref: '#/components/schemas/TaxParty2'
        administration_zone:
          description: Territorial part of a country to which the tax payment is related.
          $ref: '#/components/schemas/Max35Text'
        reference_number:
          description: Tax reference information that is specific to a taxing agency.
          $ref: '#/components/schemas/Max140Text'
        method:
          description: >-
            Method used to indicate the underlying business or how the tax is
            paid.
          $ref: '#/components/schemas/Max35Text'
        total_taxable_base_amount:
          description: Total amount of money on which the tax is based.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        total_tax_amount:
          description: Total amount of money as result of the calculation of the tax.
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount'
        date:
          description: Date by which tax is due.
          $ref: '#/components/schemas/ISODate'
        sequence_number:
          description: Sequential number of the tax report.
          $ref: '#/components/schemas/Number'
        record:
          type: array
          description: Record of tax details.
          items:
            $ref: '#/components/schemas/TaxRecord3'
    BranchAndFinancialInstitutionIdentification8:
      type: object
      description: >-
        Unique and unambiguous identification of a financial institution or a
        branch of a financial institution.
      additionalProperties: false
      properties:
        financial_institution_identification:
          description: >-
            Unique and unambiguous identification of a financial institution, as
            assigned under an internationally recognised or proprietary
            identification scheme.
          $ref: '#/components/schemas/FinancialInstitutionIdentification23'
        branch_identification:
          description: >-
            Identifies a specific branch of a financial institution.  Usage:
            This component should be used in case the identification information
            in the financial institution component does not provide
            identification up to branch level.
          $ref: '#/components/schemas/BranchData5'
      required:
        - financial_institution_identification
    BranchData5:
      type: object
      description: >-
        Information that locates and identifies a specific branch of a financial
        institution.
      additionalProperties: false
      properties:
        identification:
          description: >-
            Unique and unambiguous identification of a branch of a financial
            institution.
          $ref: '#/components/schemas/Max35Text'
        lei:
          description: >-
            Legal entity identification for the branch of the financial
            institution.
          $ref: '#/components/schemas/LEIIdentifier'
        name:
          description: >-
            Name by which an agent is known and which is usually used to
            identify that agent.
          $ref: '#/components/schemas/Max140Text'
        postal_address:
          description: >-
            Information that locates and identifies a specific address, as
            defined by postal services.
          $ref: '#/components/schemas/PostalAddress27'
    BusinessApplicationHeader8:
      type: object
      description: >-
        Specifies the Business Application Header of the Business Message.


        Can be used when replying to a query; can also be used when cancelling
        or amending.
      additionalProperties: false
      properties:
        character_set:
          description: >-
            Contains the character set of the text-based elements used in the
            Business Message.
          $ref: '#/components/schemas/UnicodeChartsCode'
        from:
          description: "The sending MessagingEndpoint that has created this Business Message for the receiving MessagingEndpoint that will process this Business Message.  Note\tthe sending MessagingEndpoint might be different from the sending address potentially contained in the transport header (as defined in the transport layer)."
          $ref: '#/components/schemas/Party51Choice'
        to:
          description: >-
            The MessagingEndpoint designated by the sending MessagingEndpoint to
            be the recipient who will ultimately process this Business Message. 
            Note the receiving MessagingEndpoint might be different from the
            receiving address potentially contained in the transport header (as
            defined in the transport layer).
          $ref: '#/components/schemas/Party51Choice'
        business_message_identifier:
          description: >-
            Unambiguously identifies the Business Message to the
            MessagingEndpoint that has created the Business Message.
          $ref: '#/components/schemas/Max35Text'
        message_definition_identifier:
          description: >-
            The Message Definition Identifier of the Business Message instance
            with which this Business Application Header instance is associated.
          $ref: '#/components/schemas/Max35Text'
        business_service:
          description: >-
            Specifies the business service agreed between the two
            MessagingEndpoints under which rules this Business Message is
            exchanged. To be used when there is a choice of processing services
            or processing service levels.  Example:  “marketx.hvps.01” and
            “marketx.xbdr.01” might be used to indicate that the associated
            messages are subject to different processing levels for domestic
            high value payments versus cross-border payments  within the same
            market practice.
          $ref: '#/components/schemas/Max35Text'
        market_practice:
          description: >-
            Specifies the market practice to which the message conforms. The
            market practices are a set of rules agreed between parties that
            restricts the usage of the messages in order to achieve better STP
            (Straight Through Processing) rates. A market practice specification
            may also extend the underlying message specification by using
            extensions or supplementary data of this underlying message.
          $ref: '#/components/schemas/ImplementationSpecification1'
        creation_date:
          description: >-
            Date and time when this Business Message (header) was created. Note
            Times must be normalized, using the "Z" annotation.
          $ref: '#/components/schemas/ISODateTime'
        business_processing_date:
          description: >-
            Processing date and time indicated by the sender for the receiver of
            the business message. This date may be different from the date and
            time provided in the CreationDate.  Usage: Market practice or
            bilateral agreement should specify how this element should be used.
          $ref: '#/components/schemas/ISODateTime'
        copy_duplicate:
          description: >-
            Indicates whether the message is a Copy, a Duplicate or a copy of a
            duplicate of a previously sent ISO 20022 Message.
          $ref: '#/components/schemas/CopyDuplicate1Code'
        possible_duplicate:
          description: >-
            Flag indicating if the Business Message exchanged between the
            MessagingEndpoints is possibly a duplicate.  If the receiving
            MessagingEndpoint did not receive the original, then this Business
            Message should be processed as if it were the original.   If the
            receiving MessagingEndpoint did receive the original, then it should
            perform necessary actions to avoid processing this Business Message
            again.  This will guarantee business idempotent behaviour.  NOTE:
            this is named "PossResend" in FIX - this is an application level
            resend not a network level retransmission.
          $ref: '#/components/schemas/YesNoIndicator'
        priority:
          description: >-
            Relative indication of the processing precedence of the message over
            a (set of) Business Messages with assigned priorities.
          $ref: '#/components/schemas/BusinessMessagePriorityCode'
        signature:
          description: >-
            Contains the digital signature of the Business Entity authorised to
            sign this Business Message.
          $ref: '#/components/schemas/SignatureEnvelope'
      required:
        - from
        - to
        - business_message_identifier
        - message_definition_identifier
        - creation_date
    BusinessApplicationHeaderV04:
      type: object
      description: >-
        The Business Layer deals with Business Messages. The behaviour of the
        Business Messages is fully described by the Business Transaction and the
        structure of the Business Messages is fully described by the Message
        Definitions and related Message Rules, Rules and Market Practices. All
        of which are registered in the ISO 20022 Repository.


        A single new Business Message (with its accompanying business
        application header) is created - by the sending MessagingEndpoint - for
        each business event; that is each interaction in a Business Transaction.
        A Business Message adheres to the following principles:


        - A Business Message (and its business application header) must not
        contain information about the Message Transport System or the mechanics
        or mechanism of message sending, transportation, or receipt.

        - A Business Message must be comprehensible outside of the context of
        the Transport Message. That is the Business Message must not require
        knowledge of the Transport Message to be understood.

        - A Business Message may contain headers, footers, and envelopes that
        are meaningful for the business. When present, they are treated as any
        other message content, which means that they are considered part of the
        Message Definition of the Business Message and as such will be part of
        the ISO 20022 Repository.

        - A Business Message refers to Business Actors by their Name. Each
        instance of a Business Actor has one Name. The Business Actor must not
        be referred to in the Transport Layer.


        Specific usage of this BusinessMessageHeader may be defined by the
        relevant SEG.
      additionalProperties: false
      properties:
        character_set:
          description: >-
            Contains the character set of the text-based elements used in the
            Business Message.
          $ref: '#/components/schemas/UnicodeChartsCode'
        from:
          description: "The sending MessagingEndpoint that has created this Business Message for the receiving MessagingEndpoint that will process this Business Message.  Note\tthe sending MessagingEndpoint might be different from the sending address potentially contained in the transport header (as defined in the transport layer)."
          $ref: '#/components/schemas/Party51Choice'
        to:
          description: >-
            The MessagingEndpoint designated by the sending MessagingEndpoint to
            be the recipient who will ultimately process this Business Message. 
            Note the receiving MessagingEndpoint might be different from the
            receiving address potentially contained in the transport header (as
            defined in the transport layer).
          $ref: '#/components/schemas/Party51Choice'
        business_message_identifier:
          description: >-
            Unambiguously identifies the Business Message to the
            MessagingEndpoint that has created the Business Message.
          $ref: '#/components/schemas/Max35Text'
        message_definition_identifier:
          description: >-
            The Message Definition Identifier of the Business Message instance
            with which this Business Application Header instance is associated.
          $ref: '#/components/schemas/Max35Text'
        business_service:
          description: >-
            Specifies the business service agreed between the two
            MessagingEndpoints under which rules this Business Message is
            exchanged. To be used when there is a choice of processing services
            or processing service levels.  Example:  “marketx.hvps.01” and
            “marketx.xbdr.01” might be used to indicate that the associated
            messages are subject to different processing levels for domestic
            high value payments versus cross-border payments  within the same
            market practice.
          $ref: '#/components/schemas/Max35Text'
        market_practice:
          description: >-
            Specifies the market practice to which the message conforms. The
            market practices are a set of rules agreed between parties that
            restricts the usage of the messages in order to achieve better STP
            (Straight Through Processing) rates. A market practice specification
            may also extend the underlying message specification by using
            extensions or supplementary data of this underlying message.
          $ref: '#/components/schemas/ImplementationSpecification1'
        creation_date:
          description: Date and time when this Business Message (header) was created.
          $ref: '#/components/schemas/ISODateTime'
        business_processing_date:
          description: >-
            Processing date and time indicated by the sender for the receiver of
            the business message. This date may be different from the date and
            time provided in the CreationDate.  Usage: Market practice or
            bilateral agreement should specify how this element should be used.
          $ref: '#/components/schemas/ISODateTime'
        copy_duplicate:
          description: >-
            Indicates whether the message is a Copy, a Duplicate or a copy of a
            duplicate of a previously sent ISO 20022 Message.
          $ref: '#/components/schemas/CopyDuplicate1Code'
        possible_duplicate:
          description: >-
            Flag indicating if the Business Message exchanged between the
            MessagingEndpoints is possibly a duplicate.  If the receiving
            MessagingEndpoint did not receive the original, then this Business
            Message should be processed as if it were the original.   If the
            receiving MessagingEndpoint did receive the original, then it should
            perform necessary actions to avoid processing this Business Message
            again.  This will guarantee business idempotent behaviour.  NOTE:
            this is named "PossResend" in FIX - this is an application level
            resend not a network level retransmission.
          $ref: '#/components/schemas/YesNoIndicator'
        priority:
          description: >-
            Relative indication of the processing precedence of the message over
            a (set of) Business Messages with assigned priorities.
          $ref: '#/components/schemas/BusinessMessagePriorityCode'
        signature:
          description: >-
            Contains the digital signature of the Business Entity authorised to
            sign this Business Message.
          $ref: '#/components/schemas/SignatureEnvelope'
        related:
          type: array
          description: >-
            Specifies the Business Application Header(s) of the Business
            Message(s) to which this Business Message relates. Can be used when
            replying to a query; can also be used when canceling or amending.
          items:
            $ref: '#/components/schemas/BusinessApplicationHeader8'
      required:
        - from
        - to
        - business_message_identifier
        - message_definition_identifier
        - creation_date
    BusinessMessagePriorityCode:
      type: string
      description: >-
        Specifies the priority levels for the BusinessMessage.


        The different priorities are typically user / service / implementation
        dependent. The semantics of the different values for a Message (Set)
        need to be defined by the relevant user community (SEG.).
    Contact13:
      type: object
      description: Specifies the details of the contact person.
      additionalProperties: false
      properties:
        name_prefix:
          description: Specifies the terms used to formally address a person.
          $ref: '#/components/schemas/NamePrefix2Code'
        name:
          description: >-
            Name by which a party is known and which is usually used to identify
            that party.
          $ref: '#/components/schemas/Max140Text'
        phone_number:
          description: >-
            Collection of information that identifies a phone number, as defined
            by telecom services.
          $ref: '#/components/schemas/PhoneNumber'
        mobile_number:
          description: >-
            Collection of information that identifies a mobile phone number, as
            defined by telecom services.
          $ref: '#/components/schemas/PhoneNumber'
        fax_number:
          description: >-
            Collection of information that identifies a FAX number, as defined
            by telecom services.
          $ref: '#/components/schemas/PhoneNumber'
        url_address:
          description: >-
            Address for the Universal Resource Locator (URL), for example an
            address used over the www (HTTP) service.
          $ref: '#/components/schemas/Max2048Text'
        email_address:
          description: Address for electronic mail (e-mail).
          $ref: '#/components/schemas/Max256Text'
        email_purpose:
          description: Purpose for which an email address may be used.
          $ref: '#/components/schemas/Max35Text'
        job_title:
          description: Title of the function.
          $ref: '#/components/schemas/Max35Text'
        responsibility:
          description: Role of a person in an organisation.
          $ref: '#/components/schemas/Max35Text'
        department:
          description: Identification of a division of a large organisation or building.
          $ref: '#/components/schemas/Max70Text'
        other:
          type: array
          description: Contact details in another form.
          items:
            $ref: '#/components/schemas/OtherContact1'
        preferred_method:
          description: Preferred method used to reach the contact.
          $ref: '#/components/schemas/PreferredContactMethod2Code'
    CopyDuplicate1Code:
      type: string
      description: >-
        Specifies if this document is a copy, a duplicate, or a duplicate of a
        copy.

        *`CODU`-Message is being sent as a copy to a party other than the
        account owner, for information purposes and the message is a duplicate
        of a message previously sent.

        *`COPY`-Message is being sent as a copy to a party other than the
        account owner, for information purposes.

        *`DUPL`-Message is for information/confirmation purposes. It is a
        duplicate of a message previously sent.
      enum:
        - CODU
        - COPY
        - DUPL
    FinancialInstitutionIdentification23:
      type: object
      description: Specifies the details to identify a financial institution.
      additionalProperties: false
      properties:
        bicfi:
          description: >-
            Code allocated to a financial institution by the ISO 9362
            Registration Authority as described in ISO 9362 "Banking - Banking
            telecommunication messages - Business identifier code (BIC)".
          $ref: '#/components/schemas/BICFIDec2014Identifier'
        clearing_system_member_identification:
          description: Information used to identify a member within a clearing system.
          $ref: '#/components/schemas/ClearingSystemMemberIdentification2'
        lei:
          description: Legal entity identifier of the financial institution.
          $ref: '#/components/schemas/LEIIdentifier'
        name:
          description: >-
            Name by which an agent is known and which is usually used to
            identify that agent.
          $ref: '#/components/schemas/Max140Text'
        postal_address:
          description: >-
            Information that locates and identifies a specific address, as
            defined by postal services.
          $ref: '#/components/schemas/PostalAddress27'
        other:
          description: >-
            Unique identification of an agent, as assigned by an institution,
            using an identification scheme.
          $ref: '#/components/schemas/GenericFinancialIdentification1'
    GenericOrganisationIdentification3:
      type: object
      description: Information related to an identification of an organisation.
      additionalProperties: false
      properties:
        identification:
          description: Identification assigned by an institution.
          $ref: '#/components/schemas/Max256Text'
        scheme_name:
          description: Name of the identification scheme.
          $ref: '#/components/schemas/OrganisationIdentificationSchemeName1Choice'
        issuer:
          description: Entity that assigns the identification.
          $ref: '#/components/schemas/Max35Text'
      required:
        - identification
    GenericPersonIdentification2:
      type: object
      description: Information related to an identification of a person.
      additionalProperties: false
      properties:
        identification:
          description: Unique and unambiguous identification of a person.
          $ref: '#/components/schemas/Max256Text'
        scheme_name:
          description: Name of the identification scheme.
          $ref: '#/components/schemas/PersonIdentificationSchemeName1Choice'
        issuer:
          description: Entity that assigns the identification.
          $ref: '#/components/schemas/Max35Text'
      required:
        - identification
    ImplementationSpecification1:
      type: object
      description: >-
        Identifies the implementation specification to which the ISO 20022
        message conforms.
      additionalProperties: false
      properties:
        registry:
          description: >-
            Name of the implementation specification registry in which the
            implementation specification of the ISO 20022 message is maintained.
            For example, "MyStandards".
          $ref: '#/components/schemas/Max350Text'
        identification:
          description: >-
            Identifier which unambiguously identifies, within the implementation
            specification registry, the implementation specification to which
            the ISO 20022 message is compliant. This can be done via a URN. It
            can also contain a version number or date. For instance, "2018-01-01
            – Version 2" or "urn:uuid:6e8bc430-9c3a-11d9-9669-0800200c9a66".
          $ref: '#/components/schemas/Max2048Text'
      required:
        - registry
        - identification
    Max256Text:
      type: string
      description: Specifies a character string with a maximum length of 256 characters.
      minLength: 1
      maxLength: 256
    OrganisationIdentification39:
      type: object
      description: Unique and unambiguous way to identify an organisation.
      additionalProperties: false
      properties:
        any_bic:
          description: Business identification code of the organisation.
          $ref: '#/components/schemas/AnyBICDec2014Identifier'
        lei:
          description: >-
            Legal entity identification as an alternate identification for a
            party.
          $ref: '#/components/schemas/LEIIdentifier'
        other:
          type: array
          description: >-
            Unique identification of an organisation, as assigned by an
            institution, using an identification scheme.
          items:
            $ref: '#/components/schemas/GenericOrganisationIdentification3'
    Party51Choice:
      type: object
      description: Identification of a person, an organisation or a financial institution.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            organisation_identification:
              description: Identification of a person or an organisation.
              $ref: '#/components/schemas/PartyIdentification272'
          required:
            - organisation_identification
        - type: object
          additionalProperties: false
          properties:
            financial_institution_identification:
              description: Identification of a financial institution.
              $ref: >-
                #/components/schemas/BranchAndFinancialInstitutionIdentification8
          required:
            - financial_institution_identification
    Party52Choice:
      type: object
      description: Specifies the identification of a person or an organisation.
      additionalProperties: true
      oneOf:
        - type: object
          additionalProperties: false
          properties:
            organisation_identification:
              description: Unique and unambiguous way to identify an organisation.
              $ref: '#/components/schemas/OrganisationIdentification39'
          required:
            - organisation_identification
        - type: object
          additionalProperties: false
          properties:
            private_identification:
              description: >-
                Unique and unambiguous identification of a person, for example a
                passport.
              $ref: '#/components/schemas/PersonIdentification18'
          required:
            - private_identification
    PartyIdentification272:
      type: object
      description: Specifies the identification of a person or an organisation.
      additionalProperties: false
      properties:
        name:
          description: >-
            Name by which a party is known and which is usually used to identify
            that party.
          $ref: '#/components/schemas/Max140Text'
        postal_address:
          description: >-
            Information that locates and identifies a specific address, as
            defined by postal services.
          $ref: '#/components/schemas/PostalAddress27'
        identification:
          description: Unique and unambiguous identification of a party.
          $ref: '#/components/schemas/Party52Choice'
        country_of_residence:
          description: >-
            Country in which a person resides (the place of a person's home). In
            the case of a company, it is the country from which the affairs of
            that company are directed.
          $ref: '#/components/schemas/CountryCode'
        contact_details:
          description: Set of elements used to indicate how to contact the party.
          $ref: '#/components/schemas/Contact13'
    PersonIdentification18:
      type: object
      description: Unique and unambiguous way to identify a person.
      additionalProperties: false
      properties:
        date_and_place_of_birth:
          description: Date and place of birth of a person.
          $ref: '#/components/schemas/DateAndPlaceOfBirth1'
        other:
          type: array
          description: >-
            Unique identification of a person, as assigned by an institution,
            using an identification scheme.
          items:
            $ref: '#/components/schemas/GenericPersonIdentification2'
    PostalAddress27:
      type: object
      description: >-
        Information that locates and identifies a specific address, as defined
        by postal services.
      additionalProperties: false
      properties:
        address_type:
          description: Identifies the nature of the postal address.
          $ref: '#/components/schemas/AddressType3Choice'
        care_of:
          description: >-
            Identifies an addressee that is accepting the correspondence for the
            intended recipient. Using care of ensures the correspondence reaches
            the right recipient rather than getting returned to the sender.
          $ref: '#/components/schemas/Max140Text'
        department:
          description: Identification of a division of a large organisation or building.
          $ref: '#/components/schemas/Max70Text'
        sub_department:
          description: >-
            Identification of a sub-division of a large organisation or
            building.
          $ref: '#/components/schemas/Max70Text'
        street_name:
          description: Name of a street or thoroughfare.
          $ref: '#/components/schemas/Max140Text'
        building_number:
          description: Number that identifies the position of a building on a street.
          $ref: '#/components/schemas/Max16Text'
        building_name:
          description: Name of the building or house.
          $ref: '#/components/schemas/Max140Text'
        floor:
          description: Floor or storey within a building.
          $ref: '#/components/schemas/Max70Text'
        unit_number:
          description: Identifies a flat or dwelling within the building.
          $ref: '#/components/schemas/Max16Text'
        post_box:
          description: >-
            Numbered box in a post office, assigned to a person or organisation,
            where letters are kept until called for.
          $ref: '#/components/schemas/Max16Text'
        room:
          description: Building room number.
          $ref: '#/components/schemas/Max70Text'
        post_code:
          description: >-
            Identifier consisting of a group of letters and/or numbers that is
            added to a postal address to assist the sorting of mail.
          $ref: '#/components/schemas/Max16Text'
        town_name:
          description: >-
            Name of a built-up area, with defined boundaries, and a local
            government.
          $ref: '#/components/schemas/Max140Text'
        town_location_name:
          description: Specific location name within the town.
          $ref: '#/components/schemas/Max140Text'
        district_name:
          description: Identifies a subdivision within a country sub-division.
          $ref: '#/components/schemas/Max140Text'
        country_sub_division:
          description: Identifies a subdivision of a country such as state, region, county.
          $ref: '#/components/schemas/Max35Text'
        country:
          description: Nation with its own government.
          $ref: '#/components/schemas/CountryCode'
        address_line:
          type: array
          maxItems: 7
          description: >-
            Information that locates and identifies a specific address, as
            defined by postal services, presented in free format text.
          items:
            $ref: '#/components/schemas/Max70Text'
    PreferredContactMethod2Code:
      type: string
      description: >-
        Preferred method used to reach the individual contact within an
        organisation.

        *`MAIL`-Preferred method used to reach the contact is per email.

        *`FAXX`-Preferred method used to reach the contact is per fax.

        *`LETT`-Preferred method used to reach the contact is per letter.

        *`CELL`-Preferred method used to reach the contact is per mobile or cell
        phone.

        *`ONLI`-Preferred method used to reach the contact is online.

        *`PHON`-Preferred method used to reach the contact is per phone.
      enum:
        - MAIL
        - FAXX
        - LETT
        - CELL
        - ONLI
        - PHON
    SignatureEnvelope:
      type: object
      description: >-
        The W3C XML Schema that specifies following standard signature:


        XML Signature Syntax and Processing (Second Edition) W3C Recommendation
        10 June 2008


        http://www.w3.org/TR/2008/REC-xmldsig-core-20080610/.
    UnicodeChartsCode:
      type: string
      description: >-
        codelist containing the names of the UNICODE code block name as
        specified on http://unicode.org/Public/UNIDATA/Blocks.txt.
    YesNoIndicator:
      type: boolean
      description: Indicates a "Yes" or "No" type of answer for an element.
    V1PaymentErrorResponse:
      description: Payment Initiation Error
      type: object
      properties:
        type:
          description: Failure Type
          type: string
        title:
          description: Failure Reason
          type: string
        errors:
          description: ''
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
              path:
                type: string
      required:
        - type
        - title
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: GROUP_IDP_URL/as/token.oauth2
          scopes:
            payment-initiation.core-payments.credit-transfer-initiations.write: Create Initiation
security:
  - oauth2: []
